Constructor
-
new DroppedParticipant(participantService, conference)
-
DroppedParticipant class represents a participant that has dropped from the conference.
Parameters:
Name Type Description participantService
AvayaClientServices.Services.Conference.ParticipantService conference
AvayaClientServices.Services.Conference
Methods
-
getAddress() → {string}
-
Returns participant's address
- Inherited From:
Returns:
{ string }
-
getAllPossibleContactMatches() → {AvayaClientServices.Services.Contacts.MatchedContactsWithMatchLevel|undefined}
-
Return all possible contact matches or undefined if there are no matches.
Returns:
-
getBestContactMatch() → {AvayaClientServices.Services.Contacts.Contact|undefined}
-
Return best possible contact match. If no match was found, undefined is returned.
- Inherited From:
Returns:
{ AvayaClientServices.Services.Contacts.Contact | undefined }
-
getDisplayName() → {string}
-
Returns participant's display name.
- Inherited From:
Returns:
{ string }
-
getParticipantId() → {string}
-
Returns participant's unique id.
- Inherited From:
Returns:
{ string }
-
isLocalUser() → {boolean}
-
Returns true, if participant is self.
- Inherited From:
Returns:
{ boolean }
-
<protected> setAddress(address)
-
Sets participant's address.
Parameters:
Name Type Description address
string - Inherited From:
-
setDisplayName(displayName)
-
Returns participant's display name.
Parameters:
Name Type Description displayName
string - Inherited From:
Callbacks
-
addOnParticipantMatchedContactsChangedCallback(callback) → {void}
-
Adds new onParticipantMatchedContactsChangedCallback.
Parameters:
Name Type Description callback
AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback Function to be called
- Inherited From:
Returns:
{ void }
-
removeOnParticipantMatchedContactsChangedCallback(callback) → {void}
-
Removes existing onParticipantMatchedContactsChangedCallback.
Parameters:
Name Type Description callback
AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback Function to be removed
- Inherited From:
Returns:
{ void }
Capabilities
-
getAssignParticipantAsLecturerCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the participant can become a lecturer.
- Inherited From:
Returns:
-
getBlockParticipantVideoCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the video of participant can be blocked.
- Inherited From:
Returns:
-
getChangeParticipantNameCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the participant can change another participant name(if first one is owner of VRM)
- Inherited From:
Returns:
-
getChangeRoleCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the participant's role can be changed.
Returns:
-
getLowerParticipantHandCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the participant's hand can be lowered.
- Inherited From:
Returns:
-
getMuteParticipantAudioCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the audio of participant can be muted.
- Inherited From:
Returns:
-
getRemoteCameraControlCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the participant's remote camera can be controlled.
- Inherited From:
Returns:
-
getUnblockParticipantVideoCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the video of participant can be unblocked.
- Inherited From:
Returns:
-
getUnmuteParticipantAudioCapability() → {AvayaClientServices.Base.Capability}
-
Returns the capability indicating if the audio of participant can be unmuted.
- Inherited From:
Returns:
Type Definitions
-
onParticipantMatchedContactsChangedCallback(participant) → {void}
-
Interface for callback function to be invoked when matched contacts for this participant are changed.
Parameters:
Name Type Description participant
AvayaClientServices.Services.Participant Participant the matched contacts of which were changed
- Inherited From:
Returns:
{ void }