com.azure.android.communication.chat

Class ChatThreadClient

java.lang.Object

com.azure.android.communication.chat.ChatThreadClient

public final class ChatThreadClient
extends java.lang.Object

Sync Client that supports chat thread operations.

Method Summary

Modifier and Type	Method and Description
void	addParticipant(ChatParticipant participant) Adds a participant to a thread.
AddChatParticipantsResult	addParticipants(java.lang.Iterable<ChatParticipant> participants) Adds participants to a thread.
com.azure.android.core.rest.Response<AddChatParticipantsResult>	addParticipantsWithResponse(java.lang.Iterable<ChatParticipant> participants, com.azure.android.core.util.RequestContext requestContext) Adds participants to a thread.
com.azure.android.core.rest.Response<java.lang.Void>	addParticipantWithResponse(ChatParticipant participant, com.azure.android.core.util.RequestContext requestContext) Adds a participant to a thread.
void	deleteMessage(java.lang.String chatMessageId) Deletes a message.
com.azure.android.core.rest.Response<java.lang.Void>	deleteMessageWithResponse(java.lang.String chatMessageId, com.azure.android.core.util.RequestContext requestContext) Deletes a message.
java.lang.String	getChatThreadId() Get the thread id.
ChatMessage	getMessage(java.lang.String chatMessageId) Gets a message by id.
com.azure.android.core.rest.Response<ChatMessage>	getMessageWithResponse(java.lang.String chatMessageId, com.azure.android.core.util.RequestContext requestContext) Gets a message by id.
ChatThreadProperties	getProperties() Gets chat thread properties.
com.azure.android.core.rest.Response<ChatThreadProperties>	getPropertiesWithResponse(com.azure.android.core.util.RequestContext requestContext) Gets chat thread properties.
com.azure.android.core.rest.util.paging.PagedIterable<ChatMessage>	listMessages() Gets the list of thread messages.
com.azure.android.core.rest.util.paging.PagedIterable<ChatMessage>	listMessages(ListChatMessagesOptions listMessagesOptions, com.azure.android.core.util.RequestContext requestContext) Gets the list of thread messages.
com.azure.android.core.rest.util.paging.PagedIterable<ChatParticipant>	listParticipants() Gets the list of the thread participants.
com.azure.android.core.rest.util.paging.PagedIterable<ChatParticipant>	listParticipants(ListParticipantsOptions listParticipantsOptions, com.azure.android.core.util.RequestContext requestContext) Gets the list of the thread participants.
com.azure.android.core.rest.util.paging.PagedIterable<ChatMessageReadReceipt>	listReadReceipts() Gets the list of thread read receipts.
com.azure.android.core.rest.util.paging.PagedIterable<ChatMessageReadReceipt>	listReadReceipts(ListReadReceiptOptions listReadReceiptOptions, com.azure.android.core.util.RequestContext requestContext) Gets the list of thread read receipts.
void	removeParticipant(com.azure.android.communication.common.CommunicationIdentifier identifier) Remove a participant from a thread.
com.azure.android.core.rest.Response<java.lang.Void>	removeParticipantWithResponse(com.azure.android.communication.common.CommunicationIdentifier identifier, com.azure.android.core.util.RequestContext requestContext) Remove a participant from a thread.
SendChatMessageResult	sendMessage(SendChatMessageOptions options) Sends a message to a thread.
com.azure.android.core.rest.Response<SendChatMessageResult>	sendMessageWithResponse(SendChatMessageOptions options, com.azure.android.core.util.RequestContext requestContext) Sends a message to a thread.
void	sendReadReceipt(java.lang.String chatMessageId) Posts a read receipt event to a thread, on behalf of a user.
com.azure.android.core.rest.Response<java.lang.Void>	sendReadReceiptWithResponse(java.lang.String chatMessageId, com.azure.android.core.util.RequestContext requestContext) Posts a read receipt event to a thread, on behalf of a user.
void	sendTypingNotification() Posts a typing event to a thread, on behalf of a user.
com.azure.android.core.rest.Response<java.lang.Void>	sendTypingNotificationWithResponse(com.azure.android.core.util.RequestContext requestContext) Posts a typing event to a thread, on behalf of a user.
com.azure.android.core.rest.Response<java.lang.Void>	sendTypingNotificationWithResponse(TypingNotificationOptions typingNotificationOptions, com.azure.android.core.util.RequestContext requestContext) Posts a typing event to a thread, on behalf of a user.
void	updateMessage(java.lang.String chatMessageId, UpdateChatMessageOptions options) Updates a message.
com.azure.android.core.rest.Response<java.lang.Void>	updateMessageWithResponse(java.lang.String chatMessageId, UpdateChatMessageOptions options, com.azure.android.core.util.RequestContext requestContext) Updates a message.
void	updateTopic(java.lang.String topic) Updates a thread's topic.
com.azure.android.core.rest.Response<java.lang.Void>	updateTopicWithResponse(java.lang.String topic, com.azure.android.core.util.RequestContext requestContext) Updates a thread's topic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getChatThreadId

public java.lang.String getChatThreadId()

Get the thread id.

Returns:

the thread id.

getProperties

public ChatThreadProperties getProperties()

Gets chat thread properties.

Returns:

the thread properties.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getPropertiesWithResponse

public com.azure.android.core.rest.Response<ChatThreadProperties> getPropertiesWithResponse(com.azure.android.core.util.RequestContext requestContext)

Gets chat thread properties.

Parameters:

requestContext - The context to associate with this operation.

Returns:

the thread with the given id.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTopic

public void updateTopic(java.lang.String topic)

Updates a thread's topic.

Parameters:

topic - The new topic.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTopicWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> updateTopicWithResponse(java.lang.String topic,
                                                                                    com.azure.android.core.util.RequestContext requestContext)

Updates a thread's topic.

Parameters:

topic - The new topic.

requestContext - The context to associate with this operation.

Returns:

the response of the update request.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addParticipants

public AddChatParticipantsResult addParticipants(java.lang.Iterable<ChatParticipant> participants)

Adds participants to a thread. If participants already exist, no change occurs.

Parameters:

participants - Participants to add.

Returns:

the add participants result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addParticipantsWithResponse

public com.azure.android.core.rest.Response<AddChatParticipantsResult> addParticipantsWithResponse(java.lang.Iterable<ChatParticipant> participants,
                                                                                                   com.azure.android.core.util.RequestContext requestContext)

Adds participants to a thread. If participants already exist, no change occurs.

Parameters:

participants - Participants to add.

requestContext - the context to associate with this operation.

Returns:

the response containing operation result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addParticipant

public void addParticipant(ChatParticipant participant)

Adds a participant to a thread. If the participant already exists, no change occurs.

Parameters:

participant - The new participant.

Throws:

ChatErrorResponseException - if the request is rejected by server.

InvalidParticipantException - if the participant is rejected by the server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addParticipantWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> addParticipantWithResponse(ChatParticipant participant,
                                                                                       com.azure.android.core.util.RequestContext requestContext)

Adds a participant to a thread. If the participant already exists, no change occurs.

Parameters:

participant - The new participant.

requestContext - The context to associate with this operation.

Returns:

the response containing operation result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

InvalidParticipantException - if the participant is rejected by the server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeParticipantWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> removeParticipantWithResponse(com.azure.android.communication.common.CommunicationIdentifier identifier,
                                                                                          com.azure.android.core.util.RequestContext requestContext)

Remove a participant from a thread.

Parameters:

identifier - Identity of the participant to remove from the thread.

requestContext - The context to associate with this operation.

Returns:

the response of the remove request.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeParticipant

public void removeParticipant(com.azure.android.communication.common.CommunicationIdentifier identifier)

Remove a participant from a thread.

Parameters:

identifier - Identity of the thread participant to remove from the thread.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listParticipants

public com.azure.android.core.rest.util.paging.PagedIterable<ChatParticipant> listParticipants()

Gets the list of the thread participants.

Returns:

the list of the thread participants.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listParticipants

public com.azure.android.core.rest.util.paging.PagedIterable<ChatParticipant> listParticipants(ListParticipantsOptions listParticipantsOptions,
                                                                                               com.azure.android.core.util.RequestContext requestContext)

Gets the list of the thread participants.

Parameters:

listParticipantsOptions - the list options.

requestContext - the context to associate with this operation.

Returns:

the list of the thread participants.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendMessageWithResponse

public com.azure.android.core.rest.Response<SendChatMessageResult> sendMessageWithResponse(SendChatMessageOptions options,
                                                                                           com.azure.android.core.util.RequestContext requestContext)

Sends a message to a thread.

Parameters:

options - options for sending the message.

requestContext - the context to associate with this operation.

Returns:

the response containing the send message result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendMessage

public SendChatMessageResult sendMessage(SendChatMessageOptions options)

Sends a message to a thread.

Parameters:

options - options for sending the message.

Returns:

the send message result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getMessageWithResponse

public com.azure.android.core.rest.Response<ChatMessage> getMessageWithResponse(java.lang.String chatMessageId,
                                                                                com.azure.android.core.util.RequestContext requestContext)

Gets a message by id.

Parameters:

chatMessageId - the message id.

requestContext - the context to associate with this operation.

Returns:

the response containing the chat message.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getMessage

public ChatMessage getMessage(java.lang.String chatMessageId)

Gets a message by id.

Parameters:

chatMessageId - The message id.

Returns:

a message by id.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMessages

public com.azure.android.core.rest.util.paging.PagedIterable<ChatMessage> listMessages()

Gets the list of thread messages.

Returns:

the list of thread messages.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMessages

public com.azure.android.core.rest.util.paging.PagedIterable<ChatMessage> listMessages(ListChatMessagesOptions listMessagesOptions,
                                                                                       com.azure.android.core.util.RequestContext requestContext)

Gets the list of thread messages.

Parameters:

listMessagesOptions - the list options.

requestContext - the context to associate with this operation.

Returns:

the list of thread messages.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateMessageWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> updateMessageWithResponse(java.lang.String chatMessageId,
                                                                                      UpdateChatMessageOptions options,
                                                                                      com.azure.android.core.util.RequestContext requestContext)

Updates a message.

Parameters:

chatMessageId - the message id.

options - options for updating the message.

requestContext - the context to associate with this operation.

Returns:

the response of the update request.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateMessage

public void updateMessage(java.lang.String chatMessageId,
                          UpdateChatMessageOptions options)

Updates a message.

Parameters:

chatMessageId - the message id.

options - options for updating the message.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteMessageWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> deleteMessageWithResponse(java.lang.String chatMessageId,
                                                                                      com.azure.android.core.util.RequestContext requestContext)

Deletes a message.

Parameters:

chatMessageId - the message id.

requestContext - the context to associate with this operation.

Returns:

the response of the delete request.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteMessage

public void deleteMessage(java.lang.String chatMessageId)

Deletes a message.

Parameters:

chatMessageId - the message id.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendTypingNotificationWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> sendTypingNotificationWithResponse(com.azure.android.core.util.RequestContext requestContext)

Posts a typing event to a thread, on behalf of a user.

Parameters:

requestContext - the context to associate with this operation.

Returns:

the completion.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendTypingNotification

public void sendTypingNotification()

Posts a typing event to a thread, on behalf of a user.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendTypingNotificationWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> sendTypingNotificationWithResponse(TypingNotificationOptions typingNotificationOptions,
                                                                                               com.azure.android.core.util.RequestContext requestContext)

Posts a typing event to a thread, on behalf of a user.

Parameters:

typingNotificationOptions - the options for sending the typing notification.

requestContext - the context to associate with this operation.

Returns:

the completion.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendReadReceiptWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> sendReadReceiptWithResponse(java.lang.String chatMessageId,
                                                                                        com.azure.android.core.util.RequestContext requestContext)

Posts a read receipt event to a thread, on behalf of a user.

Parameters:

chatMessageId - The id of the chat message that was read.

requestContext - The context to associate with this operation.

Returns:

the response containing the operation result.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

sendReadReceipt

public void sendReadReceipt(java.lang.String chatMessageId)

Posts a read receipt event to a thread, on behalf of a user.

Parameters:

chatMessageId - The id of the chat message that was read.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listReadReceipts

public com.azure.android.core.rest.util.paging.PagedIterable<ChatMessageReadReceipt> listReadReceipts()

Gets the list of thread read receipts.

Returns:

the list of thread read receipts.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listReadReceipts

public com.azure.android.core.rest.util.paging.PagedIterable<ChatMessageReadReceipt> listReadReceipts(ListReadReceiptOptions listReadReceiptOptions,
                                                                                                      com.azure.android.core.util.RequestContext requestContext)

Gets the list of thread read receipts.

Parameters:

listReadReceiptOptions - the list options.

requestContext - the context to associate with this operation.

Returns:

the list of thread read receipts.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.