ChatThreadClient class

Paquet:

@azure/communication-chat

Le client pour effectuer des opérations de conversation

Constructeurs

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Propriétés

threadId

ID de thread du ChatThreadClient

Méthodes

addParticipants(AddParticipantsRequest, OperationOptions)	Ajoute les détails des participants de conversation appartenant au thread identifié par threadId.
deleteMessage(string, OperationOptions)	Supprime un message identifié par threadId et messageId
getMessage(string, OperationOptions)	Obtient un message de conversation identifié par messageId. Retourne le message spécifique.
getProperties(OperationOptions)	Obtient un fil de conversation. Retourne le thread de conversation.
listMessages(RestListMessagesOptions)	Obtient une liste de messages d’un thread identifié par threadId. Retourne la liste des messages.
listParticipants(RestListParticipantsOptions)	Obtient les participants du thread identifié par threadId. Retourne les listes des participants.
listReadReceipts(RestListReadReceiptsOptions)	Obtient une liste de reçus de lecture d’un thread identifié par threadId. Retourne la liste des messages.
removeParticipant(CommunicationIdentifier, OperationOptions)	Supprime le participant du thread identifié par threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Envoie un message de conversation à un thread identifié par threadId. Retourne l’ID du message créé.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Envoie un reçu de lecture au thread identifié par threadId.
sendTypingNotification(SendTypingNotificationOptions)	Envoie une notification de saisie au thread. Ne tente pas d’envoyer si l’heure depuis la dernière notification est inférieure à l’intervalle minimal de saisie
updateMessage(string, UpdateMessageOptions)	Met à jour un message identifié par threadId et messageId
updateTopic(string, UpdateTopicOptions)	Met à jour la rubrique d’un thread.

Détails du constructeur

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Paramètres

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Détails de la propriété

threadId

ID de thread du ChatThreadClient

threadId: string

Valeur de propriété

string

Détails de la méthode

addParticipants(AddParticipantsRequest, OperationOptions)

Ajoute les détails des participants de conversation appartenant au thread identifié par threadId.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Paramètres

request

AddParticipantsRequest

Détails des participants de thread à ajouter dans la liste des threads

options

OperationOptions

Options d’opération.

Retours

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Supprime un message identifié par threadId et messageId

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Paramètres

messageId

string

ID de message du message.

options

OperationOptions

Options d’opération.

Retours

Promise<void>

getMessage(string, OperationOptions)

Obtient un message de conversation identifié par messageId. Retourne le message spécifique.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Paramètres

messageId

string

ID de message du message.

options

OperationOptions

Options d’opération.

Retours

Promise<ChatMessage>

getProperties(OperationOptions)

Obtient un fil de conversation. Retourne le thread de conversation.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Paramètres

options

OperationOptions

Options d’opération.

Retours

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Obtient une liste de messages d’un thread identifié par threadId. Retourne la liste des messages.

function listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Paramètres

options

RestListMessagesOptions

Obtenir les options de messages.

Retours

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Obtient les participants du thread identifié par threadId. Retourne les listes des participants.

function listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Paramètres

options

RestListParticipantsOptions

Options d’opération.

Retours

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Obtient une liste de reçus de lecture d’un thread identifié par threadId. Retourne la liste des messages.

function listReadReceipts(options?: RestListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Paramètres

options

RestListReadReceiptsOptions

Obtenir les options de messages.

Retours

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Supprime le participant du thread identifié par threadId.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Paramètres

participant

CommunicationIdentifier

Participant de thread à supprimer de la liste des threads

options

OperationOptions

Options d’opération.

Retours

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Envoie un message de conversation à un thread identifié par threadId. Retourne l’ID du message créé.

function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>

Paramètres

request

SendMessageRequest

Demande d’envoi d’un message.

options

SendMessageOptions

Options d’opération.

Retours

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Envoie un reçu de lecture au thread identifié par threadId.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Paramètres

request

SendReadReceiptRequest

Demande d’envoi d’un reçu de lecture

options

OperationOptions

Options d’opération.

Retours

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Envoie une notification de saisie au thread. Ne tente pas d’envoyer si l’heure depuis la dernière notification est inférieure à l’intervalle minimal de saisie

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Paramètres

options

SendTypingNotificationOptions

Options d’opération

Retours

Promise<boolean>

True si la notification de message de saisie peut être envoyée, sinon false.

updateMessage(string, UpdateMessageOptions)

Met à jour un message identifié par threadId et messageId

function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>

Paramètres

messageId

string

ID de message du message.

options

UpdateMessageOptions

Options d’opération.

Retours

Promise<void>

updateTopic(string, UpdateTopicOptions)

Met à jour la rubrique d’un thread.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Paramètres

topic

string

La rubrique doit être mise à jour.

options

UpdateTopicOptions

Options d’opération.

Retours

Promise<void>