Conversation Class

Package:

com.microsoft.cognitiveservices.speech.transcription

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.34.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.transcription.Conversation

Implements

java.lang.AutoCloseable

public final class Conversation
implements java.lang.AutoCloseable

Performs conversation management including add and remove participants. Note: close() must be called in order to release underlying resources held by the object. Added in version 1.8.0

Constructor Summary

Modifier	Constructor	Description
protected	Conversation(long handleValue)	Protected constructor.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<Participant>	addParticipantAsync(Participant participant) Add a participant to a conversation using a participant object.
java.util.concurrent.Future<User>	addParticipantAsync(User user) Add a participant to a conversation using a user object.
java.util.concurrent.Future<Participant>	addParticipantAsync(String userId) Add a participant to a conversation using the user's id.
void	close() Dispose of associated resources.
static java.util.concurrent.Future<Conversation>	createConversationAsync(SpeechConfig speechConfig) Initializes a new instance of Conversation.
static java.util.concurrent.Future<Conversation>	createConversationAsync(SpeechConfig speechConfig, String conversationId) Initializes a new instance of Conversation.
java.util.concurrent.Future<java.lang.Void>	deleteConversationAsync() Delete a conversation.
protected void	dispose(boolean disposing) PROTECTED
java.util.concurrent.Future<java.lang.Void>	endConversationAsync() End a conversation.
java.lang.String	getAuthorizationToken() Gets the authorization token used to communicate with the service.
java.lang.String	getConversationId() Gets the conversation Id.
SafeHandle	getImpl() Returns the comversation implementation.
PropertyCollection	getProperties() The collection of properties and their values defined for this Conversation.
java.util.concurrent.Future<java.lang.Void>	lockConversationAsync() Lock a conversation.
java.util.concurrent.Future<java.lang.Void>	muteAllParticipantsAsync() Mute all other participants in the conversation.
java.util.concurrent.Future<java.lang.Void>	muteParticipantAsync(String userId) Mute a participant.
java.util.concurrent.Future<java.lang.Void>	removeParticipantAsync(Participant participant) Remove a participant from a conversation using a participant object.
java.util.concurrent.Future<java.lang.Void>	removeParticipantAsync(User user) Remove a participant from a conversation using a user object.
java.util.concurrent.Future<java.lang.Void>	removeParticipantAsync(String userId) Remove a participant from a conversation using a user id.
void	setAuthorizationToken(String token) Sets the authorization token used to communicate with the service.
java.util.concurrent.Future<java.lang.Void>	startConversationAsync() Start a conversation.
java.util.concurrent.Future<java.lang.Void>	unlockConversationAsync() Unlocks a conversation.
java.util.concurrent.Future<java.lang.Void>	unmuteAllParticipantsAsync() Unmute all other participants in the conversation.
java.util.concurrent.Future<java.lang.Void>	unmuteParticipantAsync(String userId) Unmute a participant.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Conversation

protected Conversation(long handleValue)

Protected constructor.

Parameters:

handleValue - Internal conversation implementation

Method Details

addParticipantAsync

public Future addParticipantAsync(Participant participant)

Add a participant to a conversation using a participant object.

Parameters:

participant - A participant object.

Returns:

A task representing the asynchronous operation of adding a participant.

addParticipantAsync

public Future addParticipantAsync(User user)

Add a participant to a conversation using a user object.

Parameters:

user - A user object.

Returns:

A task representing the asynchronous operation of adding a participant.

addParticipantAsync

public Future addParticipantAsync(String userId)

Add a participant to a conversation using the user's id.

Parameters:

userId - The user id.

Returns:

A task representing the asynchronous operation of adding a participant.

close

public void close()

Dispose of associated resources. Note: close() must be called in order to release underlying resources held by the object.

createConversationAsync

public static Future createConversationAsync(SpeechConfig speechConfig)

Initializes a new instance of Conversation.

Parameters:

speechConfig - speech configuration.

Returns:

A task representing the asynchronous operation that creates a conversation.

createConversationAsync

public static Future createConversationAsync(SpeechConfig speechConfig, String conversationId)

Initializes a new instance of Conversation.

Parameters:

speechConfig - speech configuration.

conversationId - a unqiue identification of your conversation.

Returns:

A task representing the asynchronous operation that creates a conversation.

deleteConversationAsync

public Future deleteConversationAsync()

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

Returns:

An asynchronous operation representing deleting a conversation.

dispose

protected void dispose(boolean disposing)

PROTECTED

Parameters:

disposing - PROTECTED

endConversationAsync

public Future endConversationAsync()

End a conversation.

Returns:

An empty task representing the asynchronous operation that ending a conversation.

getAuthorizationToken

public String getAuthorizationToken()

Gets the authorization token used to communicate with the service.

Returns:

Authorization token.

getConversationId

public String getConversationId()

Gets the conversation Id.

Returns:

the conversation Id.

getImpl

public SafeHandle getImpl()

Returns the comversation implementation.

Returns:

The implementation of the conversation.

getProperties

public PropertyCollection getProperties()

The collection of properties and their values defined for this Conversation.

Returns:

The collection of properties and their values defined for this Conversation.

lockConversationAsync

public Future lockConversationAsync()

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

Returns:

An asynchronous operation representing locking a conversation.

muteAllParticipantsAsync

public Future muteAllParticipantsAsync()

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.

Returns:

An asynchronous operation representing muting all participants.

muteParticipantAsync

public Future muteParticipantAsync(String userId)

Mute a participant.

Parameters:

userId - A user identifier.

Returns:

An asynchronous operation representing muting a particular participant.

removeParticipantAsync

public Future removeParticipantAsync(Participant participant)

Remove a participant from a conversation using a participant object.

Parameters:

participant - A participant object.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

removeParticipantAsync

public Future removeParticipantAsync(User user)

Remove a participant from a conversation using a user object.

Parameters:

user - A user object.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

removeParticipantAsync

public Future removeParticipantAsync(String userId)

Remove a participant from a conversation using a user id.

Parameters:

userId - A user id.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

setAuthorizationToken

public void setAuthorizationToken(String token)

Sets the authorization token used to communicate with the service. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. Otherwise, the recognizer will encounter errors during recognition.

Parameters:

token - Authorization token.

startConversationAsync

public Future startConversationAsync()

Start a conversation.

Returns:

An asynchronous operation representing starting a conversation.

unlockConversationAsync

public Future unlockConversationAsync()

Unlocks a conversation.

Returns:

An asynchronous operation representing unlocking a conversation.

unmuteAllParticipantsAsync

public Future unmuteAllParticipantsAsync()

Unmute all other participants in the conversation.

Returns:

An asynchronous operation representing un-muting all participants.

unmuteParticipantAsync

public Future unmuteParticipantAsync(String userId)

Unmute a participant.

Parameters:

userId - A user identifier.

Returns:

An asynchronous operation representing un-muting a particular participant.