Conversation class

Properties

authorizationToken
config
conversationId
conversationInfo
participants
properties
speechRecognitionLanguage

Methods

addParticipantAsync(IParticipant, Callback, Callback)

Add Participant to Conversation.

createConversationAsync(SpeechTranslationConfig, string | Callback, Callback, Callback)

Create a conversation

deleteConversationAsync(Callback, Callback)

Delete a conversation. After this no one will be able to join the conversation.

endConversationAsync(Callback, Callback)

End a conversation.

lockConversationAsync(Callback, Callback)

Lock a conversation. This will prevent new participants from joining.

muteAllParticipantsAsync(Callback, Callback)

Mute all other participants in the conversation. After this no other participants will have their speech recognitions broadcast, nor be able to send text messages.

muteParticipantAsync(string, Callback, Callback)

Mute a participant.

removeParticipantAsync(string | IParticipant | IUser, Callback, Callback)

Remove a participant from a conversation using the user id, Participant or User object

startConversationAsync(Callback, Callback)

Start a conversation.

unlockConversationAsync(Callback, Callback)

Unlocks a conversation.

unmuteAllParticipantsAsync(Callback, Callback)

Unmute all other participants in the conversation.

unmuteParticipantAsync(string, Callback, Callback)

Unmute a participant.

Property Details

authorizationToken

string authorizationToken

Property Value

string

config

SpeechTranslationConfig config

Property Value

conversationId

string conversationId

Property Value

string

conversationInfo

ConversationInfo conversationInfo

Property Value

participants

Participant[] participants

Property Value

properties

PropertyCollection properties

Property Value

speechRecognitionLanguage

string speechRecognitionLanguage

Property Value

string

Method Details

addParticipantAsync(IParticipant, Callback, Callback)

Add Participant to Conversation.

function addParticipantAsync(participant: IParticipant, cb?: Callback, err?: Callback)

Parameters

participant
IParticipant
err
Callback

createConversationAsync(SpeechTranslationConfig, string | Callback, Callback, Callback)

Create a conversation

static function createConversationAsync(speechConfig: SpeechTranslationConfig, arg2?: string | Callback, arg3?: Callback, arg4?: Callback)

Parameters

arg2

string | Callback

arg3
Callback
arg4
Callback

Returns

deleteConversationAsync(Callback, Callback)

Delete a conversation. After this no one will be able to join the conversation.

function deleteConversationAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

endConversationAsync(Callback, Callback)

End a conversation.

function endConversationAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

lockConversationAsync(Callback, Callback)

Lock a conversation. This will prevent new participants from joining.

function lockConversationAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

muteAllParticipantsAsync(Callback, Callback)

Mute all other participants in the conversation. After this no other participants will have their speech recognitions broadcast, nor be able to send text messages.

function muteAllParticipantsAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

muteParticipantAsync(string, Callback, Callback)

Mute a participant.

function muteParticipantAsync(userId: string, cb?: Callback, err?: Callback)

Parameters

userId

string

A user identifier

err
Callback

removeParticipantAsync(string | IParticipant | IUser, Callback, Callback)

Remove a participant from a conversation using the user id, Participant or User object

function removeParticipantAsync(userId: string | IParticipant | IUser, cb?: Callback, err?: Callback)

Parameters

userId

string | IParticipant | IUser

A user identifier

err
Callback

startConversationAsync(Callback, Callback)

Start a conversation.

function startConversationAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

unlockConversationAsync(Callback, Callback)

Unlocks a conversation.

function unlockConversationAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

unmuteAllParticipantsAsync(Callback, Callback)

Unmute all other participants in the conversation.

function unmuteAllParticipantsAsync(cb?: Callback, err?: Callback)

Parameters

err
Callback

unmuteParticipantAsync(string, Callback, Callback)

Unmute a participant.

function unmuteParticipantAsync(userId: string, cb?: Callback, err?: Callback)

Parameters

userId

string

A user identifier

err
Callback