ConversationImpl class

Extends

Constructors

ConversationImpl(SpeechTranslationConfig, string)

Create a conversation impl

Properties

authorizationToken
config
connection
conversationId
conversationInfo
conversationTranslator
host
isConnected
isMutedByHost
me
participants
properties
room
speechRecognitionLanguage
transcriberRecognizer

Methods

addParticipantAsync(IParticipant, Callback, Callback)

Join a conversation as a participant.

changeNicknameAsync(string, Callback, Callback)

Change nickname

connectTranscriberRecognizer(TranscriberRecognizer)
createConversationAsync(Callback, Callback)

Create a new conversation as Host

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

Create a conversation

deleteConversationAsync(Callback, Callback)

Deletes a conversation

deleteConversationImplAsync()
dispose(string)
endConversationAsync(Callback, Callback)

Issues a request to close the client websockets

endConversationImplAsync()
isDisposed()
joinConversationAsync(string, string, string, Callback, Callback)

Join a conversation as a participant.

lockConversationAsync(Callback, Callback)

Issues a request to lock the conversation

muteAllParticipantsAsync(Callback, Callback)

Issues a request to mute the conversation

muteParticipantAsync(string, Callback, Callback)

Issues a request to mute a participant in the conversation

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

Issues a request to remove a participant from the conversation

sendTextMessageAsync(string, Callback, Callback)

Send a text message

startConversationAsync(Callback, Callback)

Starts a new conversation as host.

unlockConversationAsync(Callback, Callback)

Issues a request to unlock the conversation

unmuteAllParticipantsAsync(Callback, Callback)

Issues a request to unmute all participants in the conversation

unmuteParticipantAsync(string, Callback, Callback)

Issues a request to unmute a participant in the conversation

Constructor Details

ConversationImpl(SpeechTranslationConfig, string)

Create a conversation impl

new ConversationImpl(speechConfig: SpeechTranslationConfig, id?: string)

Parameters

id

string

optional conversationId

Property Details

authorizationToken

string authorizationToken

Property Value

string

config

SpeechTranslationConfig config

Property Value

connection

ConversationRecognizer connection

Property Value

conversationId

string conversationId

Property Value

string

conversationInfo

ConversationInfo conversationInfo

Property Value

conversationTranslator

any conversationTranslator

Property Value

any

host

Participant host

Property Value

isConnected

boolean isConnected

Property Value

boolean

isMutedByHost

boolean isMutedByHost

Property Value

boolean

me

Participant me

Property Value

participants

Participant[] participants

Property Value

properties

PropertyCollection properties

Property Value

room

IInternalConversation room

Property Value

speechRecognitionLanguage

string speechRecognitionLanguage

Property Value

string

transcriberRecognizer

TranscriberRecognizer transcriberRecognizer

Property Value

Method Details

addParticipantAsync(IParticipant, Callback, Callback)

Join a conversation as a participant.

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

Parameters

participant
IParticipant

participant to add

err
Callback

changeNicknameAsync(string, Callback, Callback)

Change nickname

function changeNicknameAsync(nickname: string, cb?: Callback, err?: Callback)

Parameters

nickname

string

err
Callback

connectTranscriberRecognizer(TranscriberRecognizer)

function connectTranscriberRecognizer(recognizer: TranscriberRecognizer)

Parameters

Returns

Promise<void>

createConversationAsync(Callback, Callback)

Create a new conversation as Host

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

Parameters

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)

Deletes a conversation

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

Parameters

err
Callback

deleteConversationImplAsync()

function deleteConversationImplAsync()

Returns

Promise<void>

dispose(string)

function dispose(reason?: string)

Parameters

reason

string

endConversationAsync(Callback, Callback)

Issues a request to close the client websockets

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

Parameters

err
Callback

endConversationImplAsync()

function endConversationImplAsync()

Returns

Promise<void>

isDisposed()

function isDisposed()

Returns

boolean

joinConversationAsync(string, string, string, Callback, Callback)

Join a conversation as a participant.

function joinConversationAsync(conversationId: string, nickname: string, lang: string, cb?: Callback, err?: Callback)

Parameters

conversationId

string

nickname

string

lang

string

err
Callback

lockConversationAsync(Callback, Callback)

Issues a request to lock the conversation

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

Parameters

err
Callback

muteAllParticipantsAsync(Callback, Callback)

Issues a request to mute the conversation

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

Parameters

err
Callback

muteParticipantAsync(string, Callback, Callback)

Issues a request to mute a participant in the conversation

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

Parameters

userId

string

err
Callback

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

Issues a request to remove a participant from the conversation

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

Parameters

userId

string | IParticipant | IUser

err
Callback

sendTextMessageAsync(string, Callback, Callback)

Send a text message

function sendTextMessageAsync(message: string, cb?: Callback, err?: Callback)

Parameters

message

string

err
Callback

startConversationAsync(Callback, Callback)

Starts a new conversation as host.

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

Parameters

err
Callback

unlockConversationAsync(Callback, Callback)

Issues a request to unlock the conversation

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

Parameters

err
Callback

unmuteAllParticipantsAsync(Callback, Callback)

Issues a request to unmute all participants in the conversation

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

Parameters

err
Callback

unmuteParticipantAsync(string, Callback, Callback)

Issues a request to unmute a participant in the conversation

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

Parameters

userId

string

err
Callback