Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AddChatParticipantsResult - Class in com.azure.communication.chat.models
-
Result of the add chat participants operation.
- AddChatParticipantsResult(List<ChatError>) - Constructor for class com.azure.communication.chat.models.AddChatParticipantsResult
- addParticipant(ChatParticipant) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Adds a participant to a thread.
- addParticipant(ChatParticipant) - Method in class com.azure.communication.chat.ChatThreadClient
-
Adds a participant to a thread.
- addParticipant(ChatParticipant) - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Adds another participant to the list of participants to create the chat thread with
- addParticipants(Iterable<ChatParticipant>) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Adds participants to a thread.
- addParticipants(Iterable<ChatParticipant>) - Method in class com.azure.communication.chat.ChatThreadClient
-
Adds participants to a thread.
- Add participants - Search tag in Overview
- Section
- addParticipantsWithResponse(Iterable<ChatParticipant>) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Adds participants to a thread.
- addParticipantsWithResponse(Iterable<ChatParticipant>, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Adds participants to a thread.
- addParticipantWithResponse(ChatParticipant) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Adds a participant to a thread.
- addParticipantWithResponse(ChatParticipant, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Adds a participant to a thread.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Adds a
pipeline policy
to apply on each request sent. - addPolicy(HttpPipelinePolicy) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Adds a
pipeline policy
to apply on each request sent. - Azure Communication Chat client library for Java - Search tag in Overview
- Section
B
- buildAsyncClient() - Method in class com.azure.communication.chat.ChatClientBuilder
-
Create asynchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
- buildAsyncClient() - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Create asynchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
- buildClient() - Method in class com.azure.communication.chat.ChatClientBuilder
-
Create synchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
- buildClient() - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Create synchronous chat thread client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy.
C
- ChatAsyncClient - Class in com.azure.communication.chat
-
Async Client that supports chat operations.
- ChatAttachment - Class in com.azure.communication.chat.models
-
An attachment in a chat message.
- ChatAttachment(String, ChatAttachmentType) - Constructor for class com.azure.communication.chat.models.ChatAttachment
-
Create a new instance of ChatAttachment
- ChatAttachmentType - Class in com.azure.communication.chat.models
-
Defines values for ChatAttachmentType.
- ChatAttachmentType() - Constructor for class com.azure.communication.chat.models.ChatAttachmentType
- ChatClient - Class in com.azure.communication.chat
-
Sync Client that supports chat operations.
- ChatClientBuilder - Class in com.azure.communication.chat
-
Builder for creating clients of Azure Communication Service Chat
- ChatClientBuilder() - Constructor for class com.azure.communication.chat.ChatClientBuilder
- ChatError - Class in com.azure.communication.chat.models
-
The Chat Services error.
- ChatError(String, String, String, List<ChatError>, ChatError) - Constructor for class com.azure.communication.chat.models.ChatError
-
Constructs a new ChatError
- ChatErrorResponseException - Exception Class in com.azure.communication.chat.models
-
Exception thrown on chat specific errors
- ChatErrorResponseException(String, HttpResponse) - Constructor for exception class com.azure.communication.chat.models.ChatErrorResponseException
-
Initializes a new instance of the ChatErrorResponseException class.
- ChatErrorResponseException(String, HttpResponse, ChatError) - Constructor for exception class com.azure.communication.chat.models.ChatErrorResponseException
-
Initializes a new instance of the ChatErrorResponseException class.
- ChatMessage - Class in com.azure.communication.chat.models
-
The ChatMessage model.
- ChatMessage() - Constructor for class com.azure.communication.chat.models.ChatMessage
- ChatMessageContent - Class in com.azure.communication.chat.models
-
Content of a chat message.
- ChatMessageContent(String, String, Iterable<ChatParticipant>, CommunicationIdentifier) - Constructor for class com.azure.communication.chat.models.ChatMessageContent
-
Constructs a new ChatMessageContent
- Chat Message Operations - Search tag in Overview
- Section
- ChatMessageReadReceipt - Class in com.azure.communication.chat.models
-
The ChatMessageReadReceipt model.
- ChatMessageReadReceipt() - Constructor for class com.azure.communication.chat.models.ChatMessageReadReceipt
- ChatMessageType - Class in com.azure.communication.chat.models
-
The chat message type.
- ChatMessageType() - Constructor for class com.azure.communication.chat.models.ChatMessageType
-
Deprecated.
- ChatParticipant - Class in com.azure.communication.chat.models
-
The ChatParticipant model.
- ChatParticipant() - Constructor for class com.azure.communication.chat.models.ChatParticipant
- ChatServiceVersion - Enum in com.azure.communication.chat
-
The versions of Chat Service supported by this client library.
- ChatThreadAsyncClient - Class in com.azure.communication.chat
-
Async Client that supports chat thread operations.
- ChatThreadClient - Class in com.azure.communication.chat
-
Sync Client that supports chat thread operations.
- ChatThreadClientBuilder - Class in com.azure.communication.chat
-
Builder for creating clients of Azure Communication Service Chat Threads
- ChatThreadClientBuilder() - Constructor for class com.azure.communication.chat.ChatThreadClientBuilder
- chatThreadId(String) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the ChatThreadId used to construct a client for this chat thread.
- ChatThreadItem - Class in com.azure.communication.chat.models
-
Summary information of a chat thread.
- ChatThreadItem() - Constructor for class com.azure.communication.chat.models.ChatThreadItem
-
Creates an instance of ChatThreadItem class.
- Chat Thread Operations - Search tag in Overview
- Section
- Chat Thread Participant Operations - Search tag in Overview
- Section
- ChatThreadProperties - Class in com.azure.communication.chat.models
-
The ChatThread model.
- ChatThreadProperties() - Constructor for class com.azure.communication.chat.models.ChatThreadProperties
- clientOptions(ClientOptions) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- clientOptions(ClientOptions) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- com.azure.communication.chat - package com.azure.communication.chat
-
Package containing the classes for AzureCommunicationChatService.
- com.azure.communication.chat.models - package com.azure.communication.chat.models
-
Package containing the data models for AzureCommunicationChatService.
- configuration(Configuration) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the configuration object used to retrieve environment configuration values during building of the client.
- configuration(Configuration) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the configuration object used to retrieve environment configuration values during building of the client.
- Contributing - Search tag in Overview
- Section
- Create, get, list, update, and delete chat threads - Search tag in Overview
- Section
- Create a chat thread - Search tag in Overview
- Section
- createChatThread(CreateChatThreadOptions) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Creates a chat thread.
- createChatThread(CreateChatThreadOptions) - Method in class com.azure.communication.chat.ChatClient
-
Creates a chat thread.
- CreateChatThreadOptions - Class in com.azure.communication.chat.models
-
The CreateChatThreadOptions model.
- CreateChatThreadOptions(String) - Constructor for class com.azure.communication.chat.models.CreateChatThreadOptions
-
Creates a new instance of CreateChatThreadOptions
- CreateChatThreadResult - Class in com.azure.communication.chat.models
-
The CreateChatThreadResult model.
- CreateChatThreadResult(ChatThreadProperties, List<ChatError>) - Constructor for class com.azure.communication.chat.models.CreateChatThreadResult
-
Constructs a new instance of CreateChatThreadResult
- createChatThreadWithResponse(CreateChatThreadOptions) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Creates a chat thread.
- createChatThreadWithResponse(CreateChatThreadOptions, Context) - Method in class com.azure.communication.chat.ChatClient
-
Creates a chat thread.
- Create the Chat Client - Search tag in Overview
- Section
- credential(CommunicationTokenCredential) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Set a token credential for authorization
- credential(CommunicationTokenCredential) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Set a token credential for authorization
D
- Delete a chat message - Search tag in Overview
- Section
- Delete a thread - Search tag in Overview
- Section
- deleteChatThread(String) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Deletes a chat thread.
- deleteChatThread(String) - Method in class com.azure.communication.chat.ChatClient
-
Deletes a chat thread.
- deleteChatThreadWithResponse(String) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Deletes a chat thread.
- deleteChatThreadWithResponse(String, Context) - Method in class com.azure.communication.chat.ChatClient
-
Deletes a chat thread.
- deleteMessage(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Deletes a message.
- deleteMessage(String) - Method in class com.azure.communication.chat.ChatThreadClient
-
Deletes a message.
- deleteMessageWithResponse(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Deletes a message.
- deleteMessageWithResponse(String, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Deletes a message.
E
- endpoint(String) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Set endpoint of the service
- endpoint(String) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Set endpoint of the service
- Examples - Search tag in Overview
- Section
F
- FILE - Static variable in class com.azure.communication.chat.models.ChatAttachmentType
-
Static value file for ChatAttachmentType.
- fromString(String) - Static method in class com.azure.communication.chat.models.ChatAttachmentType
-
Creates or finds a ChatAttachmentType from its string representation.
- fromString(String) - Static method in class com.azure.communication.chat.models.ChatMessageType
-
Creates or finds a ChatMessageType from its string representation.
G
- Get, add, and remove participants - Search tag in Overview
- Section
- Get a chat message - Search tag in Overview
- Section
- Get a chat thread client - Search tag in Overview
- Section
- Get a chat thread properties - Search tag in Overview
- Section
- getAttachments() - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Get the attachment property: Chat message content for messages of type attachments
- getAttachmentType() - Method in class com.azure.communication.chat.models.ChatAttachment
-
Get the attachmentType property: The type of attachment.
- getChatError() - Method in exception class com.azure.communication.chat.models.InvalidParticipantException
-
Gets the underlying ChatError returned from the server
- getChatMessageId() - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Get the chatMessageId property: Id for the chat message that has been read.
- Get chat messages - Search tag in Overview
- Section
- getChatThread() - Method in class com.azure.communication.chat.models.CreateChatThreadResult
-
Get the chatThread property: The chatThread property.
- getChatThreadClient(String) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Creates a chat thread client.
- getChatThreadClient(String) - Method in class com.azure.communication.chat.ChatClient
-
Creates a chat thread client.
- getChatThreadId() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Get the thread id property.
- getChatThreadId() - Method in class com.azure.communication.chat.ChatThreadClient
-
Get the thread id property.
- getCode() - Method in class com.azure.communication.chat.models.ChatError
-
Get the code property: The error code.
- getCommunicationIdentifier() - Method in class com.azure.communication.chat.models.ChatParticipant
-
Get the communicationIdentifier property: Identifies a participant in Azure Communication services.
- getContent() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the content property: Content of the chat message.
- getContent() - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Get the content property: Chat message content.
- getContent() - Method in class com.azure.communication.chat.models.UpdateChatMessageOptions
-
Get the content property: Chat message content.
- getCreatedBy() - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Get the createdBy property: Identifies a participant in Azure Communication services.
- getCreatedOn() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the createdOn property: The timestamp when the chat message arrived at the server.
- getCreatedOn() - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Get the createdOn property: The timestamp when the chat thread was created.
- getDeletedOn() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the deletedOn property: The timestamp when the chat message was deleted.
- getDeletedOn() - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Get the deletedOn property: The timestamp when the chat thread was deleted.
- getDetails() - Method in class com.azure.communication.chat.models.ChatError
-
Get the details property: Further details about specific errors that led to this error.
- getDisplayName() - Method in class com.azure.communication.chat.models.ChatParticipant
-
Get the displayName property: Display name for the chat participant.
- getEditedOn() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the editedOn property: The timestamp when the chat message was edited.
- getId() - Method in class com.azure.communication.chat.models.ChatAttachment
-
Get the id property: Id of the attachment.
- getId() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the id property: The id of the chat message.
- getId() - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Get the id property: Chat thread id.
- getId() - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Get the id property: Chat thread id.
- getId() - Method in class com.azure.communication.chat.models.SendChatMessageResult
-
Get the id property: A server-generated message id.
- getIdempotencyToken() - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Get the idempotencyToken property
- getInitiator() - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Get the initiator property: Chat message content for messages of types participantAdded or participantRemoved.
- getInnerError() - Method in class com.azure.communication.chat.models.ChatError
-
Get the innerError property: The inner error if any.
- getInvalidParticipants() - Method in class com.azure.communication.chat.models.AddChatParticipantsResult
-
Get the invalidParticipants property: The participants that failed to be added to the chat thread.
- getInvalidParticipants() - Method in class com.azure.communication.chat.models.CreateChatThreadResult
-
Get the invalidParticipants property: The participants that failed to be added to the chat thread.
- getLastMessageReceivedOn() - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Get the lastMessageReceivedOn property: The timestamp when the last message arrived at the server.
- getLatest() - Static method in enum com.azure.communication.chat.ChatServiceVersion
-
Gets the latest service version supported by this client library
- getMaxPageSize() - Method in class com.azure.communication.chat.models.ListChatMessagesOptions
-
Gets the maximum page size.
- getMaxPageSize() - Method in class com.azure.communication.chat.models.ListChatThreadsOptions
-
Gets the maximum page size.
- getMaxPageSize() - Method in class com.azure.communication.chat.models.ListParticipantsOptions
-
Gets the maximum page size.
- getMaxPageSize() - Method in class com.azure.communication.chat.models.ListReadReceiptOptions
-
Gets the maximum page size.
- getMessage() - Method in class com.azure.communication.chat.models.ChatError
-
Get the message property: The error message.
- getMessage() - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Get the message property: Chat message content for messages of types text or html.
- getMessage(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets a message by id.
- getMessage(String) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets a message by id.
- getMessageWithResponse(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets a message by id.
- getMessageWithResponse(String, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets a message by id.
- getMetadata() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the metadata property: Message metadata.
- getMetadata() - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Get the metadata property: Message metadata.
- getMetadata() - Method in class com.azure.communication.chat.models.UpdateChatMessageOptions
-
Get the metadata property: Message metadata.
- getName() - Method in class com.azure.communication.chat.models.ChatAttachment
-
Get the name property: The name of the attachment content.
- getParticipants() - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Get the participants property: Chat message content for messages of types participantAdded or participantRemoved.
- getParticipants() - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Get the participants property: Participants to be added to the chat thread.
- getPreviewUrl() - Method in class com.azure.communication.chat.models.ChatAttachment
-
Get the previewUrl property: The URL where the preview of attachment can be downloaded.
- getProperties() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets chat thread properties.
- getProperties() - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets chat thread properties.
- getPropertiesWithResponse() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets chat thread properties.
- getPropertiesWithResponse(Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets chat thread properties.
- getReadOn() - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Get the readOn property: Read receipt timestamp.
- Get read receipts - Search tag in Overview
- Section
- getSender() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the sender property: Identifies a participant in Azure Communication services.
- getSender() - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Get the sender property: Identifies a participant in Azure Communication services.
- getSenderDisplayName() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the senderDisplayName property: The display name of the chat message sender.
- getSenderDisplayName() - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Get the senderDisplayName property: The display name of the chat message sender.
- getSenderDisplayName() - Method in class com.azure.communication.chat.models.TypingNotificationOptions
-
Get the senderDisplayName property: The display name of the typing notification sender.
- getShareHistoryTime() - Method in class com.azure.communication.chat.models.ChatParticipant
-
Get the shareHistoryTime property: Time from which the chat history is shared with the chat participant.
- getSkip() - Method in class com.azure.communication.chat.models.ListParticipantsOptions
-
Gets the skip for the range to query.
- getSkip() - Method in class com.azure.communication.chat.models.ListReadReceiptOptions
-
Gets the skip for the range to query.
- getStartTime() - Method in class com.azure.communication.chat.models.ListChatMessagesOptions
-
Gets the start time for the range to query.
- getStartTime() - Method in class com.azure.communication.chat.models.ListChatThreadsOptions
-
Gets the start time for the range to query.
- getTarget() - Method in class com.azure.communication.chat.models.ChatError
-
Get the target property: The error target.
- Getting started - Search tag in Overview
- Section
- getTopic() - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Get the topic property: Chat message content for messages of type topicUpdated.
- getTopic() - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Get the topic property: Chat thread topic.
- getTopic() - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Get the topic property: Chat thread topic.
- getTopic() - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Get the topic property: The chat thread topic.
- getTopic() - Method in class com.azure.communication.chat.models.UpdateChatThreadOptions
-
Get the topic property: Chat thread topic.
- getType() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the type property: Type of the chat message.
- getType() - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Get the type property: The chat message type.
- getUrl() - Method in class com.azure.communication.chat.models.ChatAttachment
-
Get the url property: The URL where the attachment can be downloaded.
- getValue() - Method in exception class com.azure.communication.chat.models.ChatErrorResponseException
- getVersion() - Method in enum com.azure.communication.chat.ChatServiceVersion
- getVersion() - Method in class com.azure.communication.chat.models.ChatMessage
-
Get the version property: Version of the chat message.
H
- HTML - Static variable in class com.azure.communication.chat.models.ChatMessageType
-
Static value html for ChatMessageType.
- httpClient(HttpClient) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
HttpClient
to use for sending and receiving requests to and from the service. - httpClient(HttpClient) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
HttpClient
to use for sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service.
I
- IMAGE - Static variable in class com.azure.communication.chat.models.ChatAttachmentType
-
Static value image for ChatAttachmentType.
- Include direct dependency - Search tag in Overview
- Section
- Include the BOM file - Search tag in Overview
- Section
- Include the package - Search tag in Overview
- Section
- InvalidParticipantException - Exception Class in com.azure.communication.chat.models
-
Exception when a participant cannot be added to a chat thread
- InvalidParticipantException(ChatError) - Constructor for exception class com.azure.communication.chat.models.InvalidParticipantException
-
Constructs a new InvalidParticipantException
K
- Key concepts - Search tag in Overview
- Section
L
- ListChatMessagesOptions - Class in com.azure.communication.chat.models
-
Additional parameters for chat messages operation.
- ListChatMessagesOptions() - Constructor for class com.azure.communication.chat.models.ListChatMessagesOptions
- List chat participants - Search tag in Overview
- Section
- listChatThreads() - Method in class com.azure.communication.chat.ChatAsyncClient
-
Gets the list of chat threads of a user.
- listChatThreads() - Method in class com.azure.communication.chat.ChatClient
-
Gets the list of chat threads of a user.
- listChatThreads(ListChatThreadsOptions) - Method in class com.azure.communication.chat.ChatAsyncClient
-
Gets the list of chat threads of a user.
- listChatThreads(ListChatThreadsOptions, Context) - Method in class com.azure.communication.chat.ChatClient
-
Gets the list of chat threads of a user.
- ListChatThreadsOptions - Class in com.azure.communication.chat.models
-
Additional parameters for chat threads operation.
- ListChatThreadsOptions() - Constructor for class com.azure.communication.chat.models.ListChatThreadsOptions
- listMessages() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets a list of messages from a thread.
- listMessages() - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets a list of messages from a thread.
- listMessages(ListChatMessagesOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets a list of messages from a thread.
- listMessages(ListChatMessagesOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets a list of messages from a thread.
- listParticipants() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets the participants of a thread.
- listParticipants() - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets the participants of a thread.
- listParticipants(ListParticipantsOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets the participants of a thread.
- listParticipants(ListParticipantsOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets the participants of a thread.
- ListParticipantsOptions - Class in com.azure.communication.chat.models
-
Additional parameters for list participants operation.
- ListParticipantsOptions() - Constructor for class com.azure.communication.chat.models.ListParticipantsOptions
- ListReadReceiptOptions - Class in com.azure.communication.chat.models
-
Additional parameters for list read receipts operation.
- ListReadReceiptOptions() - Constructor for class com.azure.communication.chat.models.ListReadReceiptOptions
- listReadReceipts() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets read receipts for a thread.
- listReadReceipts() - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets read receipts for a thread.
- listReadReceipts(ListReadReceiptOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Gets read receipts for a thread.
- listReadReceipts(ListReadReceiptOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Gets read receipts for a thread.
N
- Next steps - Search tag in Overview
- Section
P
- PARTICIPANT_ADDED - Static variable in class com.azure.communication.chat.models.ChatMessageType
-
Static value participantAdded for ChatMessageType.
- PARTICIPANT_REMOVED - Static variable in class com.azure.communication.chat.models.ChatMessageType
-
Static value participantRemoved for ChatMessageType.
- pipeline(HttpPipeline) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
HttpPipeline
to use for the service client. - pipeline(HttpPipeline) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
HttpPipeline
to use for the service client. - Prerequisites - Search tag in Overview
- Section
R
- Read Receipt Operations - Search tag in Overview
- Section
- removeParticipant(CommunicationIdentifier) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Remove a participant from a thread.
- removeParticipant(CommunicationIdentifier) - Method in class com.azure.communication.chat.ChatThreadClient
-
Remove a participant from a thread.
- Remove participant - Search tag in Overview
- Section
- removeParticipantWithResponse(CommunicationIdentifier) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Remove a participant from a thread.
- removeParticipantWithResponse(CommunicationIdentifier, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Remove a participant from a thread.
- Request a User Access Token - Search tag in Overview
- Section
- retryOptions(RetryOptions) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
RetryOptions
for all the requests made through the client. - retryOptions(RetryOptions) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
RetryOptions
for all the requests made through the client. - retryPolicy(RetryPolicy) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
HttpPipelinePolicy
that will attempt to retry requests when needed. - retryPolicy(RetryPolicy) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
HttpPipelinePolicy
that will attempt to retry requests when needed.
S
- Send, get, list, update, and delete chat messages - Search tag in Overview
- Section
- Send a chat message - Search tag in Overview
- Section
- Send and get read receipts - Search tag in Overview
- Section
- SendChatMessageOptions - Class in com.azure.communication.chat.models
-
Details of the message to send.
- SendChatMessageOptions() - Constructor for class com.azure.communication.chat.models.SendChatMessageOptions
-
Creates an instance of SendChatMessageOptions class.
- SendChatMessageResult - Class in com.azure.communication.chat.models
-
Result of the send message operation.
- SendChatMessageResult() - Constructor for class com.azure.communication.chat.models.SendChatMessageResult
-
Creates an instance of SendChatMessageResult class.
- sendMessage(SendChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Sends a message to a thread.
- sendMessage(SendChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadClient
-
Sends a message to a thread.
- sendMessageWithResponse(SendChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Sends a message to a thread.
- sendMessageWithResponse(SendChatMessageOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Sends a message to a thread.
- sendReadReceipt(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Posts a read receipt event to a thread, on behalf of a user.
- sendReadReceipt(String) - Method in class com.azure.communication.chat.ChatThreadClient
-
Posts a read receipt event to a thread, on behalf of a user.
- Send read receipt - Search tag in Overview
- Section
- sendReadReceiptWithResponse(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Posts a read receipt event to a thread, on behalf of a user.
- sendReadReceiptWithResponse(String, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Posts a read receipt event to a thread, on behalf of a user.
- sendTypingNotification() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Posts a typing event to a thread, on behalf of a user.
- sendTypingNotification() - Method in class com.azure.communication.chat.ChatThreadClient
-
Posts a typing event to a thread, on behalf of a user.
- Send typing notification - Search tag in Overview
- Section
- sendTypingNotificationWithResponse() - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Posts a typing event to a thread, on behalf of a user.
- sendTypingNotificationWithResponse(TypingNotificationOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Posts a typing event to a thread, on behalf of a user.
- sendTypingNotificationWithResponse(TypingNotificationOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Posts a typing event to a thread, on behalf of a user.
- sendTypingNotificationWithResponse(Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Posts a typing event to a thread, on behalf of a user.
- serviceVersion(ChatServiceVersion) - Method in class com.azure.communication.chat.ChatClientBuilder
-
Sets the
ChatServiceVersion
that is used when making API requests. - serviceVersion(ChatServiceVersion) - Method in class com.azure.communication.chat.ChatThreadClientBuilder
-
Sets the
ChatServiceVersion
that is used when making API requests. - setAttachments(Iterable<ChatAttachment>) - Method in class com.azure.communication.chat.models.ChatMessageContent
-
Set the attachments property: List of attachments for this message.
- Set Azure Communication Resource endpoint after it is created - Search tag in Overview
- Section
- setChatMessageId(String) - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Set the chatMessageId property: Id for the chat message that has been read.
- setCommunicationIdentifier(CommunicationIdentifier) - Method in class com.azure.communication.chat.models.ChatParticipant
-
Set the communicationIdentifier property: Identifies a participant in Azure Communication services.
- setContent(ChatMessageContent) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the content property: Content of the chat message.
- setContent(String) - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Set the content property: Chat message content.
- setContent(String) - Method in class com.azure.communication.chat.models.UpdateChatMessageOptions
-
Set the content property: Chat message content.
- setCreatedBy(CommunicationIdentifier) - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Set the createdBy property: Identifies a participant in Azure Communication services.
- setCreatedOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the createdOn property: The timestamp when the chat message arrived at the server.
- setCreatedOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Set the createdOn property: The timestamp when the chat thread was created.
- setDeletedOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the deletedOn property: The timestamp when the chat message was deleted.
- setDeletedOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Set the deletedOn property: The timestamp when the chat thread was deleted.
- setDisplayName(String) - Method in class com.azure.communication.chat.models.ChatParticipant
-
Set the displayName property: Display name for the chat participant.
- setEditedOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the editedOn property: The timestamp when the chat message was edited.
- setId(String) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the id property: The id of the chat message.
- setId(String) - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Set the id property: Chat thread id.
- setId(String) - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Set the id property: Chat thread id.
- setId(String) - Method in class com.azure.communication.chat.models.SendChatMessageResult
-
Set the id property: A server-generated message id.
- setIdempotencyToken(String) - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Set the idempotencyToken property: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same idempotencyToken and get back an appropriate response without the server executing the request multiple times.
- setMaxPageSize(Integer) - Method in class com.azure.communication.chat.models.ListChatMessagesOptions
-
Set the maximum page size.
- setMaxPageSize(Integer) - Method in class com.azure.communication.chat.models.ListChatThreadsOptions
-
Set the page size.
- setMaxPageSize(Integer) - Method in class com.azure.communication.chat.models.ListParticipantsOptions
-
Set the maximum page size.
- setMaxPageSize(Integer) - Method in class com.azure.communication.chat.models.ListReadReceiptOptions
-
Set the maximum page size.
- setMetadata(Map<String, String>) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the metadata property: Message metadata.
- setMetadata(Map<String, String>) - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Set the metadata property: Message metadata.
- setMetadata(Map<String, String>) - Method in class com.azure.communication.chat.models.UpdateChatMessageOptions
-
Set the metadata property: Message metadata.
- setName(String) - Method in class com.azure.communication.chat.models.ChatAttachment
-
Set the name property: The name of the attachment content.
- setParticipants(List<ChatParticipant>) - Method in class com.azure.communication.chat.models.CreateChatThreadOptions
-
Set the participants property: Participants to be added to the chat thread.
- setPreviewUrl(String) - Method in class com.azure.communication.chat.models.ChatAttachment
-
Set the previewUrl property: The URL where the preview of attachment can be downloaded.
- setReadOn(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Set the readOn property: Read receipt timestamp.
- setSender(CommunicationIdentifier) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the sender property: Identifies a participant in Azure Communication services.
- setSender(CommunicationIdentifier) - Method in class com.azure.communication.chat.models.ChatMessageReadReceipt
-
Set the sender property: Identifies a participant in Azure Communication services.
- setSenderDisplayName(String) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the senderDisplayName property: The display name of the chat message sender.
- setSenderDisplayName(String) - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Set the senderDisplayName property: The display name of the chat message sender.
- setSenderDisplayName(String) - Method in class com.azure.communication.chat.models.TypingNotificationOptions
-
Set the senderDisplayName property: The display name of the typing notification sender.
- setShareHistoryTime(OffsetDateTime) - Method in class com.azure.communication.chat.models.ChatParticipant
-
Set the shareHistoryTime property: Time from which the chat history is shared with the chat participant.
- setSkip(Integer) - Method in class com.azure.communication.chat.models.ListParticipantsOptions
-
Sets the skip for the range to query.
- setSkip(Integer) - Method in class com.azure.communication.chat.models.ListReadReceiptOptions
-
Sets the skip for the range to query.
- setStartTime(OffsetDateTime) - Method in class com.azure.communication.chat.models.ListChatMessagesOptions
-
Sets the start time for the range to query.
- setStartTime(OffsetDateTime) - Method in class com.azure.communication.chat.models.ListChatThreadsOptions
-
Sets the start time for the range to query.
- setTopic(String) - Method in class com.azure.communication.chat.models.ChatThreadItem
-
Set the topic property: Chat thread topic.
- setTopic(String) - Method in class com.azure.communication.chat.models.ChatThreadProperties
-
Set the topic property: Chat thread topic.
- setTopic(String) - Method in class com.azure.communication.chat.models.UpdateChatThreadOptions
-
Set the topic property: Chat thread topic.
- setType(ChatMessageType) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the type property: Type of the chat message.
- setType(ChatMessageType) - Method in class com.azure.communication.chat.models.SendChatMessageOptions
-
Set the type property: The chat message type.
- setUrl(String) - Method in class com.azure.communication.chat.models.ChatAttachment
-
Set the url property: The URL where the attachment can be downloaded.
- setVersion(String) - Method in class com.azure.communication.chat.models.ChatMessage
-
Set the version property: Version of the chat message.
T
- TEXT - Static variable in class com.azure.communication.chat.models.ChatMessageType
-
Static value text for ChatMessageType.
- TOPIC_UPDATED - Static variable in class com.azure.communication.chat.models.ChatMessageType
-
Static value topicUpdated for ChatMessageType.
- Troubleshooting - Search tag in Overview
- Section
- Typing Notification Operations - Search tag in Overview
- Section
- TypingNotificationOptions - Class in com.azure.communication.chat.models
-
Request payload for typing notifications.
- TypingNotificationOptions() - Constructor for class com.azure.communication.chat.models.TypingNotificationOptions
-
Creates an instance of TypingNotificationOptions class.
U
- Update a chat message - Search tag in Overview
- Section
- Update a chat thread topic - Search tag in Overview
- Section
- UpdateChatMessageOptions - Class in com.azure.communication.chat.models
-
Request payload for updating a chat message.
- UpdateChatMessageOptions() - Constructor for class com.azure.communication.chat.models.UpdateChatMessageOptions
-
Creates an instance of UpdateChatMessageOptions class.
- UpdateChatThreadOptions - Class in com.azure.communication.chat.models
-
Request payload for updating a chat thread.
- UpdateChatThreadOptions() - Constructor for class com.azure.communication.chat.models.UpdateChatThreadOptions
-
Creates an instance of UpdateChatThreadOptions class.
- updateMessage(String, UpdateChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Updates a message.
- updateMessage(String, UpdateChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadClient
-
Updates a message.
- updateMessageWithResponse(String, UpdateChatMessageOptions) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Updates a message.
- updateMessageWithResponse(String, UpdateChatMessageOptions, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Updates a message.
- updateTopic(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Updates a thread's topic.
- updateTopic(String) - Method in class com.azure.communication.chat.ChatThreadClient
-
Updates a thread's topic.
- updateTopicWithResponse(String) - Method in class com.azure.communication.chat.ChatThreadAsyncClient
-
Updates a thread's properties.
- updateTopicWithResponse(String, Context) - Method in class com.azure.communication.chat.ChatThreadClient
-
Updates a thread's topic.
V
- V2021_03_07 - Enum constant in enum com.azure.communication.chat.ChatServiceVersion
-
Service version
2021-03-07
. - V2021_09_27 - Enum constant in enum com.azure.communication.chat.ChatServiceVersion
-
Service version
2021-09-27
. - valueOf(String) - Static method in enum com.azure.communication.chat.ChatServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.communication.chat.ChatServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.communication.chat.models.ChatAttachmentType
- values() - Static method in class com.azure.communication.chat.models.ChatMessageType
-
Gets known ChatMessageType values.
All Classes and Interfaces|All Packages|Serialized Form
ChatMessageType.fromString(String)
factory method.