This client library enables working with the Microsoft Azure Communication Chat service.
For this release, see notes - https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/communication/Azure.Communication.Chat/README.md and https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/communication/Azure.Communication.Chat/CHANGELOG.md.
Microsoft Azure Communication Chat quickstart - https://docs.microsoft.com/azure/communication-services/quickstarts/chat/get-started?pivots=programming-language-csharp
<!--
Here's an example using the Azure CLI:
```Powershell
[To be ADDED]
```
-->
Authenticate the client
User Access Tokens
User access tokens enable you to build client applications that directly authenticate to Azure Communication Services.
For the generation of user access tokens, refer to User Access Tokens.
Using statements
using Azure.Communication.Identity;
using Azure.Communication.Chat;
Create a ChatClient
This will allow you to create, get, or delete chat threads.
ChatClient chatClient = new ChatClient(
endpoint,
new CommunicationTokenCredential(userToken));
Create a ChatThreadClient
The ChatThreadClient will allow you to perform operations specific to a chat thread, like update the chat thread topic, send a message, add participants to the chat thread, etc.
You can instantiate a new ChatThreadClient using the GetChatThread operation of the ChatClient with an existing thread id:
A chat conversation is represented by a thread. Each user in the thread is called a thread participant. Thread participants can chat with one another privately in a 1:1 chat or huddle up in a 1:N group chat. Users also get near-real time updates for when others are typing and when they have read the messages.
Once you initialized a ChatClient class, you can do the following chat operations:
We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.
Use DeleteChatThread to delete a thread.
threadId is the unique id of the thread.
await chatClient.DeleteChatThreadAsync(threadId);
Update a thread
Use UpdatePropertiesAsync to update the chat thread topic or metadata.
UpdateChatThreadPropertiesOptions updateChatThreadPropertiesOptions = new UpdateChatThreadPropertiesOptions();
updateChatThreadPropertiesOptions.Topic = "new topic !";
updateChatThreadPropertiesOptions.Metadata.Add("UpdateMetadataKey", "UpdateMetadataValue");
updateChatThreadPropertiesOptions.RetentionPolicy = ChatRetentionPolicy.ThreadCreationDate(60);
await chatThreadClient.UpdatePropertiesAsync(updateChatThreadPropertiesOptions);
Message Operations
Send a message
Use SendMessage to send a message to a thread.
Use content to provide the content for the message, it is required.
Use type for the content type of the message such as 'Text' or 'Html'. If not specified, 'Text' will be set.
Use senderDisplayName to specify the display name of the sender. If not specified, empty string will be set.
SendChatMessageResult sendChatMessageResult = await chatThreadClient.SendMessageAsync(content:"hello world");
var messageId = sendChatMessageResult.Id;
Get a message
Use GetMessage to retrieve a message from the service.
messageId is the unique id of the message.
ChatMessage is the response returned from getting a message, it contains an id, which is the unique identifier of the message, among other fields. Please refer to Azure.Communication.Chat.ChatMessage
A RequestFailedException is thrown as a service response for any unsuccessful requests. The exception contains information about what response code was returned from the service.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.