Class: Participant

Methods

getAddress() → {String}

Returns Participant address.

Returns:

{ String }

getAllPossibleContactMatches() → {AvayaClientServices.Services.Contacts.MatchedContactsWithMatchLevel|undefined}

Return all possible contact matches or undefined if there are no matches.

Inherited From:

• AvayaClientServices.Services.Participant#getAllPossibleContactMatches

Returns:

{ AvayaClientServices.Services.Contacts.MatchedContactsWithMatchLevel | undefined }

getBestContactMatch() → {AvayaClientServices.Services.Contacts.Contact|undefined}

Return best possible contact match. If no match was found, undefined is returned.

Inherited From:

• AvayaClientServices.Services.Participant#getBestContactMatch

Returns:

{ AvayaClientServices.Services.Contacts.Contact | undefined }

getDisplayName() → {String}

Returns Participant display name.

Returns:

{ String }

getGivenName() → {String}

Returns Participant given name.

Returns:

{ String }

getParticipantId() → {string}

Returns participant's unique id.

Inherited From:

• AvayaClientServices.Services.Participant#getParticipantId

Returns:

{ string }

getSupportedModalities() → {Object}

Returns Participant supported modalities.

Returns:

{ Object }

getSurname() → {String}

Returns Participant surname.

Returns:

{ String }

getType() → {String}

Returns Participant type.

Returns:

{ String }

isLocalUser() → {boolean}

Returns true, if participant is self.

Inherited From:

• AvayaClientServices.Services.Participant#isLocalUser

Returns:

{ boolean }

isSelf() → {Boolean}

Determines whether Participant is self.

Returns:

{ Boolean }

<protected> setAddress(address)

Sets participant's address.

Parameters:

Name	Type	Description
address	string

Inherited From:

• AvayaClientServices.Services.Participant#setAddress

setDisplayName(displayName)

Returns participant's display name.

Parameters:

Name	Type	Description
displayName	string

Inherited From:

• AvayaClientServices.Services.Participant#setDisplayName

Callbacks

addOnParticipantMatchedContactsChangedCallback(callback) → {void}

Adds new onParticipantMatchedContactsChangedCallback.

Parameters:

Name	Type	Description
callback	AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback	Function to be called

Inherited From:

• AvayaClientServices.Services.Participant#addOnParticipantMatchedContactsChangedCallback

Returns:

{ void }

removeOnParticipantMatchedContactsChangedCallback(callback) → {void}

Removes existing onParticipantMatchedContactsChangedCallback.

Parameters:

Name	Type	Description
callback	AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback	Function to be removed

Inherited From:

• AvayaClientServices.Services.Participant#removeOnParticipantMatchedContactsChangedCallback

Returns:

{ void }

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:

• AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback

Returns:

{ void }