Class: Conference

Constructor

new Conference(conferenceService, participantService, chat)

Conference defines all of the methods that can be invoked on a conference call.

Parameters:
Name Type Description
conferenceService AvayaClientServices.Services.Conference.ConferenceService
participantService AvayaClientServices.Services.Conference.ParticipantService
chat AvayaClientServices.Services.Conference.Chat

Methods

addParticipant(participantAddress) → {AvayaClientServices.Base.Promise}

Add a participant to a call via dial-out mechanism.

Parameters:
Name Type Description
participantAddress string

Participant to be added to the conference call.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

addParticipantFromCall(existingCall) → {AvayaClientServices.Base.Promise}

Add an existing participant to an adhoc conference.

Parameters:
Name Type Description
existingCall AvayaClientServices.Services.Call.Call
Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

extendMeeting(minutes) → {AvayaClientServices.Base.Promise}

Issues a request extending meeting.

Parameters:
Name Type Description
minutes number
Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

isEventConference() → {boolean}

Check if this conference is event conference.

Returns:
{ boolean }

lowerHand() → {AvayaClientServices.Base.Promise}

Called to lower local user's hand on the conference call to indicate that the user no longer wants to
get the moderator's attention.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

muteAllParticipants() → {AvayaClientServices.Base.Promise}

Mutes all conference participants.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

pinVideoByCoordinates(sourceX, sourceY, destX, destY) → {AvayaClientServices.Base.Promise}

Issues a request change participant position in video by coordinates.

Parameters:
Name Type Description
sourceX number

source coordinate X

sourceY number

source coordinate Y

destX number

destination coordinate X

destY number

destination coordinate Y

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

pinVideoByParticipant(sourceParticipant, destX, destY) → {AvayaClientServices.Base.Promise}

Issues a request change participant position in video by participant.

Parameters:
Name Type Description
sourceParticipant string

source participant

destX number

destination coordinate X

destY number

destination coordinate Y

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

raiseHand() → {AvayaClientServices.Base.Promise}

Called to raise local user's hand on the conference call to get the moderator's attention, who can
unmute and hence allow the participant to speak.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

removeLastParticipant() → {AvayaClientServices.Base.Promise}

Removes the last participant that was added to a conference call either locally or remotely.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

removeParticipant(participant) → {AvayaClientServices.Base.Promise}

Initiates removal of the selected participant from the conference call.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.Participant

Participant to be removed from the conference call.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

requestToBecomeModerator(moderatorPin) → {AvayaClientServices.Base.Promise}

Issues a request to promote local user to become a conference moderator.

Parameters:
Name Type Description
moderatorPin string

Optional pin required to issue the moderator request

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

sendPasscode(passcode) → {AvayaClientServices.Base.Promise}

Request for admission to enter a conference call that is passcode-protected.

Parameters:
Name Type Description
passcode string

Admission passcode.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

sendRequestToEnterLockedConference() → {AvayaClientServices.Base.Promise}

Request for permission to enter a locked conference call.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

signIn(token) → {AvayaClientServices.Base.Promise}

Issues a request to sign in during the meeting to become a user.

Parameters:
Name Type Description
token string

Token to verify the new credentials

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

start(config) → {AvayaClientServices.Base.Promise}

Start conference

Parameters:
Name Type Argument Description
config Object <optional>

@deprecated This parameter is deprecated since version 1.1.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

stop() → {AvayaClientServices.Base.Promise}

Stop conference

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

terminateConference() → {AvayaClientServices.Base.Promise}

Terminates the conference call.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

toString()

Returns a string representing Conference

unmuteAllParticipants() → {AvayaClientServices.Base.Promise}

Unmutes all conference participants.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

Managing callbacks

addOnConferenceActiveTalkersChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceActiveTalkersChangedCallback

Function to be called when specified event occurs

addOnConferenceActiveVideoParticipantsChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceActiveVideoParticipantsChangedCallback

Function to be called when specified event occurs

addOnConferenceAllParticipantsMutedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAllParticipantsMutedCallback

Function to be called when specified event occurs

addOnConferenceAllParticipantsUnmutedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAllParticipantsUnmutedCallback

Function to be called when specified event occurs

addOnConferenceAvailableVideoLayoutsChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAvailableVideoLayoutsChangedCallbacks

Function to be called when specified event occurs

addOnConferenceCollaborationURIChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceCollaborationURIChangedCallback

Function to be called when specified event occurs

addOnConferenceConnectionEndedCallbacks(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceConnectionEndedCallbacks

Function to be called when specified event occurs

addOnConferenceContinuationStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceContinuationStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceDialInInfoUpdatedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDialInInfoUpdatedCallbacks

Function to be called when specified event occurs

addOnConferenceDisplayParticipantNameOnVideoAllowedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDisplayParticipantNameOnVideoAllowedCallbacks

Function to be called when specified event occurs

addOnConferenceDisplayVideoParticipantNameChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDisplayVideoParticipantNameChangedCallback

Function to be called when specified event occurs

addOnConferenceDroppedParticipantAddedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDroppedParticipantAddedCallback

Function to be called when specified event occurs

addOnConferenceDroppedParticipantRemovedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDroppedParticipantRemovedCallback

Function to be called when specified event occurs

addOnConferenceEncryptionStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceEncryptionStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceEntryExitToneChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceEntryExitToneChangedCallback

Function to be called when specified event occurs

addOnConferenceJoinMeetingURIUpdatedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceJoinMeetingURIUpdatedCallbacks

Function to be called when specified event occurs

addOnConferenceKnockDoorTimeoutChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceKnockDoorTimeoutChangeCallback

Function to be called when specified event occurs

addOnConferenceLectureModeStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceLectureModeStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceLockStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceLockStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceMeetingTerminationInProgressCallbacks(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceMeetingTerminationInProgressCallbacks

Function to be called when specified event occurs

addOnConferenceMeetingTerminationTimeChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceMeetingTerminationTimeChangedCallback

Function to be called when specified event occurs

addOnConferenceOwnerAddressChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceOwnerAddressChangedCallback

Function to be called when specified event occurs

addOnConferenceParticipantsAddedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceParticipantsAddedCallback

Function to be called when specified event occurs

addOnConferenceParticipantsRemovedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceParticipantsRemovedCallback

Function to be called when specified event occurs

addOnConferencePendingParticipantCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePendingParticipantCallback

Function to be called when specified event occurs

addOnConferencePendingParticipantRemovedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePendingParticipantRemovedCallback

Function to be called when specified event occurs

addOnConferencePresentationModeStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePresentationModeStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceRecordingFailedCallbacks(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceRecordingFailedCallbacks

Function to be called when specified event occurs

addOnConferenceRecordingStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceRecordingStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceServiceAvailableCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceServiceAvailableCallback

Function to be called when specified event occurs

addOnConferenceServiceUnavailableCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceServiceUnavailableCallback

Function to be called when specified event occurs

addOnConferenceStartingCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStartingCallback

Function to be called when specified event occurs

addOnConferenceStreamingStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStreamingStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceStreamingURIUpdatedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStreamingURIUpdatedCallbacks

Function to be called when specified event occurs

addOnConferenceSubjectCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceSubjectChangeCallback

Function to be called when specified event occurs

addOnConferenceVideoLayoutChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoLayoutChangedCallbacks

Function to be called when specified event occurs

addOnConferenceVideoPinAllowedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoPinAllowedCallbacks

Function to be called when specified event occurs

addOnConferenceVideoSelfSeeAllowedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoSelfSeeAllowedCallbacks

Function to be called when specified event occurs

addOnConferenceVideoSelfSeeChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoSelfSeeChangedCallbacks

Function to be called when specified event occurs

addOnConferenceVideoStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoStatusChangedCallback

Function to be called when specified event occurs

addOnConferenceWaitingToStartCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceWaitingToStartCallbacks

Function to be called when specified event occurs

addOnEventConferenceStatusChangedCallback(callback)

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onEventConferenceStatusChangedCallbacks

removeOnConferenceActiveTalkersChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceActiveTalkersChangedCallback

Function to be removed

removeOnConferenceActiveVideoParticipantsChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceActiveVideoParticipantsChangedCallback

Function to be removed

removeOnConferenceAllParticipantsMutedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAllParticipantsMutedCallback

Function to be removed

removeOnConferenceAllParticipantsUnmutedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAllParticipantsUnmutedCallback

Function to be removed

removeOnConferenceAvailableVideoLayoutsChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceAvailableVideoLayoutsChangedCallbacks

Function to be removed

removeOnConferenceCollaborationURIChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceCollaborationURIChangedCallback

Function to be removed

removeOnConferenceConnectionEndedCallbacks(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceConnectionEndedCallbacks

Function to be removed

removeOnConferenceContinuationStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceContinuationStatusChangedCallback

Function to be removed

removeOnConferenceDialInInfoUpdatedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDialInInfoUpdatedCallbacks

Function to be removed

removeOnConferenceDisplayParticipantNameOnVideoAllowedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDisplayParticipantNameOnVideoAllowedCallbacks

Function to be removed

removeOnConferenceDisplayVideoParticipantNameChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDisplayVideoParticipantNameChangedCallback

Function to be removed

removeOnConferenceDroppedParticipantAddedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDroppedParticipantAddedCallback

Function to be removed

removeOnConferenceDroppedParticipantRemovedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceDroppedParticipantRemovedCallback

Function to be removed

removeOnConferenceEncryptionStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceEncryptionStatusChangedCallback

Function to be removed

removeOnConferenceEntryExitToneChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceEntryExitToneChangedCallback

Function to be removed

removeOnConferenceJoinMeetingURIUpdatedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceJoinMeetingURIUpdatedCallbacks

Function to be removed

removeOnConferenceKnockDoorTimeoutChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceKnockDoorTimeoutChangeCallback

Function to be removed

removeOnConferenceLectureModeStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceLectureModeStatusChangedCallback

Function to be removed

removeOnConferenceLockStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceLockStatusChangedCallback

Function to be removed

removeOnConferenceMeetingTerminationInProgressCallbacks(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceMeetingTerminationInProgressCallbacks

Function to be removed

removeOnConferenceMeetingTerminationTimeChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceMeetingTerminationTimeChangedCallback

Function to be removed

removeOnConferenceOwnerAddressChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceOwnerAddressChangedCallback

Function to be removed

removeOnConferenceParticipantsAddedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceParticipantsAddedCallback

Function to be removed

removeOnConferenceParticipantsRemovedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceParticipantsRemovedCallback

Function to be removed

removeOnConferencePendingParticipantCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePendingParticipantCallback

Function to be removed

removeOnConferencePendingParticipantRemovedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePendingParticipantRemovedCallback

Function to be removed

removeOnConferencePresentationModeStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferencePresentationModeStatusChangedCallback

Function to be removed

removeOnConferenceRecordingFailedCallbacks(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceRecordingFailedCallbacks

Function to be removed

removeOnConferenceRecordingStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceRecordingStatusChangedCallback

Function to be removed

removeOnConferenceServiceAvailableCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceServiceAvailableCallback

Function to be removed

removeOnConferenceServiceUnavailableCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceServiceUnavailableCallback

Function to be removed

removeOnConferenceStartingCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStartingCallback

Function to be removed

removeOnConferenceStreamingStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStreamingStatusChangedCallback

Function to be removed

removeOnConferenceStreamingURIUpdatedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceStreamingURIUpdatedCallbacks

Function to be removed

removeOnConferenceSubjectCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceSubjectChangeCallback

Function to be removed

removeOnConferenceVideoLayoutChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoLayoutChangedCallbacks

Function to be removed

removeOnConferenceVideoPinAllowedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoPinAllowedCallbacks

Function to be removed

removeOnConferenceVideoSelfSeeAllowedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoSelfSeeAllowedCallbacks

Function to be removed

removeOnConferenceVideoSelfSeeChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoSelfSeeChangedCallbacks

Function to be removed

removeOnConferenceVideoStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceVideoStatusChangedCallback

Function to be removed

removeOnConferenceWaitingToStartCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onConferenceWaitingToStartCallbacks

Function to be removed

removeOnEventConferenceStatusChangedCallback(callback)

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.Conference#onEventConferenceStatusChangedCallbacks

Capabilities

getAcceptPendingParticipantCapability() → {AvayaClientServices.Base.Capability}

Returns:

getActiveTalkerCapability() → {AvayaClientServices.Base.Capability}

Returns:

getAddParticipantFromCallCapability(existingCall) → {AvayaClientServices.Base.Capability}

Parameters:
Name Type Description
existingCall AvayaClientServices.Services.Call.Call
Returns:

getAddParticipantViaDialoutCapability() → {AvayaClientServices.Base.Capability}

Returns:

getChangeParticipantRoleCapability() → {AvayaClientServices.Base.Capability}

Returns:

getDenyPendingParticipantCapability() → {AvayaClientServices.Base.Capability}

Returns:

getExtendMeetingCapability() → {AvayaClientServices.Base.Capability}

Returns:

getInConferenceChatCapability() → {AvayaClientServices.Base.Capability}

Returns whether in-conference chat is supported.

Returns:

getModerateConferenceCapability() → {AvayaClientServices.Base.Capability}

Returns:

getMuteAllParticipantsCapability() → {AvayaClientServices.Base.Capability}

Returns:

getMuteSelfAudioCapability() → {AvayaClientServices.Base.Capability}

Returns:

getPauseRecordingCapability() → {AvayaClientServices.Base.Capability}

Returns:

getRemoveLastParticipantCapability() → {AvayaClientServices.Base.Capability}

Returns:

getRemoveSelectParticipantCapability() → {AvayaClientServices.Base.Capability}

Returns:

getRequestToBecomeModeratorCapability() → {AvayaClientServices.Base.Capability}

Returns:

getResumeRecordingCapability() → {AvayaClientServices.Base.Capability}

Returns:

getRetrieveParticipantListCapability() → {AvayaClientServices.Base.Capability}

Returns:

getSendFeccCapability() → {AvayaClientServices.Base.Capability}

Returns:

getSignInCapability() → {AvayaClientServices.Base.Capability}

Returns:

getStartRecordingCapability() → {AvayaClientServices.Base.Capability}

Returns:

getStopRecordingCapability() → {AvayaClientServices.Base.Capability}

Returns:

getSupportLowerHandCapability() → {AvayaClientServices.Base.Capability}

Returns:

getSupportMeetingMinutesCapability() → {AvayaClientServices.Base.Capability}

Returns:

getSupportRaiseHandCapability() → {AvayaClientServices.Base.Capability}

Returns:

getTerminateConferenceCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUnmuteAllParticipantsCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUnmuteSelfAudioCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUpdateDisplayVideoParticipantNameCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUpdateLockStatusCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUpdateVideoLayoutCapability() → {AvayaClientServices.Base.Capability}

Returns:

getUpdateVideoSelfSeeCapability() → {AvayaClientServices.Base.Capability}

Returns:

getVideoPinCapability() → {AvayaClientServices.Base.Capability}

Returns:

Getters

getActiveParticipants() → {AvayaClientServices.Base.DataSet.<AvayaClientServices.Services.Conference.ActiveParticipant>}

Return the active participant list associated with the conference call.

Returns:
{ AvayaClientServices.Base.DataSet.<AvayaClientServices.Services.Conference.ActiveParticipant> }

List of active participants associated with the conference call. The method returns an empty list if this is not a conference call.

getCollaborationURI() → {string}

Returns the collaboration URI associated with the conference call, if the conference call is capable of
supporting collaboration. If the conference is not capable of supporting collaboration, undefined is returned.

Returns:
{ string }

Collaboration URI associated with the conference call.

getConferenceOwnerAddress() → {string}

Returns the conference owner address.

Returns:
{ string }

Conference owner address.

getCurrentVideoLayout() → {AvayaClientServices.Services.Conference.VideoLayout}

Return the currently selected video layout option, if the conference server supports layout selection with the conference call.

Returns:
{ AvayaClientServices.Services.Conference.VideoLayout }

Currently selected video layout option

getDialInInformation() → {string}

Returns the Dial In options associated with the conference call in text format.

Returns:
{ string }

Generic text containing the Dial In options associated with the conference call in text format.

getDialInInformationHtml() → {string}

Returns the Dial In options associated with the conference call in HTML format.

Returns:
{ string }

Generic text containing the Dial In options associated with the conference call in HTML format.

getDroppedParticipants() → {Array.<AvayaClientServices.Services.Conference.DroppedParticipant>}

Return the dropped participant list associated with the conference call.

Returns:
{ Array.<AvayaClientServices.Services.Conference.DroppedParticipant> }

List of dropped participants associated with the conference call. The method returns an empty list if this is not a conference call.

getEncryptionStatus() → {AvayaClientServices.Services.Conference.MeetingEncryptionStatus}

Returns the encryption status of the conference.

Returns:

getInConferenceChat() → {AvayaClientServices.Services.Conference.Chat}

Returns chat object associated with the conference call. Chat object can be used to query for list of messages or
send a new message.

Returns:
{ AvayaClientServices.Services.Conference.Chat }

Chat object associated with the conference call

getJoinMeetingURI() → {string}

Returns the Join Meeting URI associated with the conference call.

Returns:
{ string }

Join Meeting URI associated with the conference call.

getKnockDoorTimeout() → {number|undefined}

Returns knocking timeout in seconds.
Knock on door: request to join a meeting is rejected if no answer after this time.

Returns:
{ number | undefined }

Knocking timeout in seconds

getMeetingEndTime() → {Date}

Returns the meeting end time if an end time is specified for the conference call.

Returns:
{ Date }

getMeetingMinutes() → {AvayaClientServices.Services.Conference.MeetingMinutes|AvayaClientServices.Services.Conference.ConferenceException}

Returns MeetingMinutes object associated with the conference call. MeetingMinutes object can be used to query for
list of minutes or to add a new minute, or edit or remove an existing minute.

Returns:
{ AvayaClientServices.Services.Conference.MeetingMinutes | AvayaClientServices.Services.Conference.ConferenceException }

MeetingMinutes object associated with the conference call

getPendingParticipants() → {Array.<AvayaClientServices.Services.Conference.PendingParticipant>}

Return the pending participant list associated with the conference call.

Returns:
{ Array.<AvayaClientServices.Services.Conference.PendingParticipant> }

List of pending participants associated with the conference call. The method returns an empty list if this is not a conference call.

getSelfParticipant() → {AvayaClientServices.Services.Conference.Participant}

Returns the participant associated with the current user.

Returns:

getStreamingURI() → {string}

Returns the streaming URI associated with the conference call, if the conference call is capable of
supporting streaming. If the conference is not capable of supporting streaming, undefined is returned.

Returns:
{ string }

Streaming URI associated with the conference call.

getSubject() → {string}

Returns the subject of the conference.

Returns:
{ string }

getSupportedVideoLayoutList() → {Array.<AvayaClientServices.Services.Conference.VideoLayout>}

Returns the list of video layouts that the user can choose from. If the conference server does not support video layout selection, an empty list is returned.

Returns:
{ Array.<AvayaClientServices.Services.Conference.VideoLayout> }

Supported video layouts

isApplicationSharingActive() → {boolean}

Returns the presentation mode status of the conference call.

Returns:
{ boolean }

isConferenceWaitingToStart() → {boolean}

If the media status is Waiting Room the method returns true

Returns:
{ boolean }

Media status of the conference call.

isLectureModeActive() → {boolean}

Returns the lecture mode status of the conference call. It returns false
if the call is not a conference call, or if the conference call does not have
lecture mode active.

Returns:
{ boolean }

Lecture mode status of the conference call

isLocked() → {boolean}

Returns lock status of the conference call. If the call is not a conference call or the
conference call is not locked, the method returns false.

Returns:
{ boolean }

Lock status of the conference call.

isMuteAllParticipantsActive() → {boolean}

If the media status is MuteAllParticipants, the method returns true

Returns:
{ boolean }

Media status of the conference call.

isPasscodeRequiredToBecomeModerator() → {boolean}

Returns whether the conference call requires entry of a moderator pin before local user is allowed to become a moderator.

Returns:
{ boolean }

is pin required to become moderator

isPasscodeRequiredToEnterConference() → {boolean}

Returns true if a passcode must be provided by the client
before the client will be allowed to enter the conference

Returns:
{ boolean }

isPermissionRequiredToEnterLockedConference() → {boolean}

Returns true if the moderator must grant permission
before the client will be allowed to enter the conference

Returns:
{ boolean }

isRecordingActive() → {boolean}

Returns the recording of the conference call is active.

Returns:
{ boolean }

isRecordingPaused() → {boolean}

Returns the recording of the conference call is paused.

Returns:
{ boolean }

isStreamingActive() → {boolean}

Returns the streaming status of the conference call.

Returns:
{ boolean }

isVideoAllowed() → {boolean}

Returns the video allowed status of the conference call. If the call is not a conference
call, or if video on the conference call is not allowed, the method returns false.

Returns:
{ boolean }

Video allowed status of the conference call.

isVideoParticipantNameDisplayActive() → {boolean}

Returns display participant status of the conference call. If the call is not a conference call or the
display participant name option is currently not active, the method returns false.

Returns:
{ boolean }

Display participant name status of the conference call.

isVideoSelfSeeActive() → {boolean}

Returns self see status of the conference call. If the call is not a conference call or the
self see option is currently not active, the method returns false.

Returns:
{ boolean }

Self see status of the conference call.

Setters

pauseRecording() → {AvayaClientServices.Base.Promise}

Pauses conference recording.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

resumeRecording() → {AvayaClientServices.Base.Promise}

Resumes conference recording.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

setDisplayVideoParticipantName(displayParticipantName) → {AvayaClientServices.Base.Promise}

Controls whether participant name is displayed in the personal video layout.

Parameters:
Name Type Description
displayParticipantName boolean

Set to true if display name is to be shown; false, otherwise.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

setLocked(isLocked) → {AvayaClientServices.Base.Promise}

Locks or unlocks the conference call. If the call is not a conference call
or the conference call is not locked, the method returns false

Parameters:
Name Type Description
isLocked boolean

Set to true to lock the conference; set to false to unlock the conference.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

setVideoLayout(layout) → {AvayaClientServices.Base.Promise}

Sets the layout of the video participants on screen.

Parameters:
Name Type Description
layout AvayaClientServices.Services.Conference.VideoLayout

Selected video layout.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

setVideoSelfSee(selfSee) → {AvayaClientServices.Base.Promise}

Controls display of the local user's video in the personal video layout

Parameters:
Name Type Description
selfSee boolean

Set to true if local video is shown in the video; false, if local video is hidden.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

startRecording(name, description) → {AvayaClientServices.Base.Promise}

Starts conference recording.

Parameters:
Name Type Argument Description
name string <optional>

Name of the conference recording

description string <optional>

Description of the conference

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

stopRecording() → {AvayaClientServices.Base.Promise}

Stops conference recording.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

Type Definitions

onConferenceActiveTalkersChangedCallback(conference, activeTalkers)

Called to report the latest snapshot of active talkers on a conference call.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

activeTalkers Array.<AvayaClientServices.Services.Conference.Participant>

Participants who are active talkers

onConferenceActiveVideoParticipantsChangedCallback(conference, participants)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

participants Array.<AvayaClientServices.Services.Conference.Participant>

onConferenceAllowVideoDirectionChangedCallbacks(conference)

Report that the allow video direction by conference was changed

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceAllParticipantsMutedCallback(conference)

Report when all participants have been muted.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceAllParticipantsUnmutedCallback(conference)

Report when all participants have been unmuted.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceAvailableVideoLayoutsChangedCallbacks(conference, geometries)

Report change in conference supported video layouts.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

geometries Array.<AvayaClientServices.Services.Conference.VideoLayout>

New supported video layouts of the conference

onConferenceCollaborationURIChangedCallback(conference, collaborationURI)

Report change in collaboration URI associated with the conference

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

collaborationURI string

Collaboration URI associated with the conference call

onConferenceConnectionEndedCallbacks(conference, reason)

Report that the conference is ended.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

reason AvayaClientServices.Services.Conference.DisconnectReason

Reason of the end of conference

onConferenceContinuationStatusChangedCallback(conference, continuationStatus)

Report change in conference continuation status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

continuationStatus boolean

New continuation status of the conference

onConferenceDialInInfoUpdatedCallbacks(conference)

Report that the conference DialInInfo was changed

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceDisplayParticipantNameOnVideoAllowedCallbacks(conference, textOverlayAllowedStatus)

Report change in conference video layout text overlay allowed status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

textOverlayAllowedStatus boolean

New text overlay allowed status of the conference

onConferenceDisplayVideoParticipantNameChangedCallback(conference, textOverlayStatus)

Report change in conference video layout text overlay status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

textOverlayStatus boolean

New text overlay status of the conference

onConferenceDroppedParticipantAddedCallback(conference, participant)

Report that a dropped participant has been added e.g. when active participant has been dropped.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

participant AvayaClientServices.Services.Conference.Participant

Participant who is waiting to join the call.

onConferenceDroppedParticipantRemovedCallback(conference, participant)

Report that a dropped participant has been removed e.g. has rejoined the conference.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

participant AvayaClientServices.Services.Conference.Participant

Participant who is waiting to join the call.

onConferenceEncryptionStatusChangedCallback(conference, meetingEncryptionStatus)

Report change in conference encryption status. (Please note that this callback doesn't exist in SDK.)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

meetingEncryptionStatus AvayaClientServices.Services.Conference.MeetingEncryptionStatus

onConferenceEntryExitToneChangedCallback(conference, entryExitToneStatus)

Report change in conference entry/exit tones

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

entryExitToneStatus boolean

New status of the entry/exit tones for the conference

onConferenceJoinMeetingURIUpdatedCallbacks(conference)

Report that the conference JoinMeetingURI was changed

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceKnockDoorTimeoutChangeCallback(conference, knockDoorTimeout)

Report change in conference knockDoorTimeout

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

knockDoorTimeout number | undefined

Knock on Door timeout

onConferenceLectureModeStatusChangedCallback(conference, lectureModeStatus)

Report change in conference lecture mode.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

lectureModeStatus boolean

New lecture mode status of the conference

onConferenceLockStatusChangedCallback(conference, lockStatus)

Report change in conference lock status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

lockStatus boolean

New lock status of the conference

onConferenceMeetingTerminationInProgressCallbacks(conference, reason, userName)

Report meeting termination progress started.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

reason string
userName string

onConferenceMeetingTerminationTimeChangedCallback(conference, date)

Report change in meeting termination date. (Please note that this callback doesn't exist in SDK.)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

date Date

Meeting termination date.

onConferenceOwnerAddressChangedCallback(conference, ownerAddress)

Report a change in the conference owner's address

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

ownerAddress string

New owner's address for the conference

onConferenceParticipantsAddedCallback(conference, addedParticipants)

Called to report that multiple participants have been added locally or remotely, or are already on the conference call.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

addedParticipants Array.<AvayaClientServices.Services.Conference.Participant>

List of participants who have been added to conference call.

onConferenceParticipantsRemovedCallback(conference, removedParticipants)

Called to report that a participant has been removed from the conference call either through a local operation or
remotely (e.g., by a remote moderator, or by participant choosing to disconnect from the conference call).

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

removedParticipants Array.<AvayaClientServices.Services.Conference.Participant>

List of participants who has been removed from the conference call.

onConferencePendingParticipantCallback(conference, participant)

Report that a participant is waiting to join the call.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

participant AvayaClientServices.Services.Conference.Participant

Participant who is waiting to join the call.

onConferencePendingParticipantRemovedCallback(conference, participant)

Report that a participant who has been waiting to join the call is no longer waiting.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

participant AvayaClientServices.Services.Conference.Participant

Participant who is waiting to join the call.

onConferencePresentationModeStatusChangedCallback(conference, presentationModeStatus)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

presentationModeStatus boolean

onConferenceRecordingFailedCallbacks(conference)

Report recording failed.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceRecordingStatusChangedCallback(conference, recordingStatus)

Report change in conference recording status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

recordingStatus AvayaClientServices.Services.Conference.RecordingStatus

New recording status of the conference

onConferenceServiceAvailableCallback(conference)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceServiceUnavailableCallback(conference)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceStartingCallback(conference, mediaStatus)

Reports that the conference has started, and the local user is no longer in waiting room.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with.

mediaStatus string

Media status.

onConferenceStreamingStatusChangedCallback(conference, isStreamingActive)

Report change in conference streaming status. (Please note that this callback doesn't exist in SDK.)

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

isStreamingActive boolean

onConferenceStreamingURIUpdatedCallbacks(conference)

Report that the conference StreamingURI was changed

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

onConferenceSubjectChangeCallback(conference, subject)

Report change in conference subject

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

subject string

New subject for the conference

onConferenceVideoLayoutChangedCallbacks(conference, geometry)

Report change in conference current video layout.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

geometry AvayaClientServices.Services.Conference.VideoLayout

New current video layout of the conference

onConferenceVideoPinAllowedCallbacks(conference, videoPinAllowedStatus)

Report change in conference video pin allowed status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

videoPinAllowedStatus boolean

New video pin allowed status of the conference

onConferenceVideoSelfSeeAllowedCallbacks(conference, noSelfSeeAllowedStatus)

Report change in conference video layout noSelfSee allowed status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

noSelfSeeAllowedStatus boolean

New no self see allowed status of the conference

onConferenceVideoSelfSeeChangedCallbacks(conference, noSelfSeeStatus)

Report change in conference video layout noSelfSee status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

noSelfSeeStatus boolean

New no self see status of the conference

onConferenceVideoStatusChangedCallback(conference, isVideoAllowed)

Report change in conference video status.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

isVideoAllowed boolean

Indication as to whether video is allowed on the conference call

onConferenceWaitingToStartCallbacks(conference, mediaStatus)

Reports that the conference has started, and the local user is no longer in waiting room.

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with.

mediaStatus string

Media status.

onEventConferenceStatusChangedCallbacks(conference, eventConference)

Report that a conference's Event Conference status changed

Parameters:
Name Type Description
conference AvayaClientServices.Services.Conference.Conference

Conference object that the callback is associated with

eventConference boolean

Flag indicating whether the conference is now Event Conference

©2016 Avaya Inc. All Rights Reserved.