chat Package

Packages

aio

Classes

ChatAttachment	An attachment in a chat message. All required parameters must be populated in order to send to Azure.
ChatClient	A client to interact with the AzureCommunicationService Chat gateway. This client provides operations to create chat thread, delete chat thread, get chat thread client by thread id, list chat threads.
ChatError	The Communication Services error. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
ChatMessage	Chat message. Variables are only populated by the server, and will be ignored when sending a request.
ChatMessageContent	Content of a chat message.
ChatMessageReadReceipt	A chat message read receipt indicates the time a chat message was read by a recipient. Variables are only populated by the server, and will be ignored when sending a request.
ChatParticipant	A participant of the chat thread. All required parameters must be populated in order to send to Azure.
ChatThreadClient	A client to interact with the AzureCommunicationService Chat gateway. Instances of this class is normally retrieved by ChatClient.get_chat_thread_client() This client provides operations to add participant(s) to chat thread, remove participant from chat thread, send message, delete message, update message, send typing notifications, send and list read receipt
ChatThreadItem	Summary information of a chat thread. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
ChatThreadProperties	ChatThreadProperties. Variables are only populated by the server, and will be ignored when sending a request.
CommunicationIdentifier	Communication Identifier.
CommunicationTokenCredential	Credential type used for authenticating to an Azure Communication service.
CommunicationUserIdentifier	Represents a user in Azure Communication Service.
CommunicationUserProperties	Dictionary of properties for a CommunicationUserIdentifier.
CreateChatThreadResult	Result of the create chat thread operation.
MicrosoftTeamsAppIdentifier	Represents an identifier for a Microsoft Teams application.
MicrosoftTeamsAppProperties	Dictionary of properties for a MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Represents an identifier for a Microsoft Teams user.
MicrosoftTeamsUserProperties	Dictionary of properties for a MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Represents a phone number.
PhoneNumberProperties	Dictionary of properties for a PhoneNumberIdentifier.
SendChatMessageResult	Result of the send message operation. All required parameters must be populated in order to send to server.
UnknownIdentifier	Represents an identifier of an unknown type. It will be encountered in communications with endpoints that are not identifiable by this version of the SDK. For checking yet unknown identifiers it is better to rely on the presence of the raw_id property, as new or existing distinct type identifiers always contain the raw_id property. It is not advisable to rely on the kind property with a value unknown, as it could become a new or existing distinct type in the future.

Enums

ChatAttachmentType	The type of attachment.
ChatMessageType	The chat message type.
CommunicationIdentifierKind	Communication Identifier Kind. For checking yet unknown identifiers it is better to rely on the presence of the raw_id property, as new or existing distinct type identifiers always contain the raw_id property. It is not advisable to rely on the kind property with a value unknown, as it could become a new or existing distinct type in the future.

Functions

identifier_from_raw_id

Creates a CommunicationIdentifier from a given raw ID.

When storing raw IDs use this function to restore the identifier that was encoded in the raw ID.

identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier

Parameters

Name	Description
raw_id Required	str A raw ID to construct the CommunicationIdentifier from.

Returns

Type	Description
CommunicationIdentifier	The CommunicationIdentifier parsed from the raw_id.