ChatClient class

Paquet:

@azure/communication-chat

Client pour effectuer des opérations de conversation

Constructeurs

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crée une instance de ChatClient pour une ressource et un utilisateur donnés.

Méthodes

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Crée un fil de conversation. Retourne le client de thread avec l’ID du thread créé.
deleteChatThread(string, OperationOptions)	Supprime un thread de conversation.
getChatThreadClient(string)	Retourne ChatThreadClient avec l’ID de thread spécifique.
listChatThreads(RestListChatThreadsOptions)	Obtient la liste des fils de conversation d’un utilisateur.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Se désabonner de chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Désinscription de chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Désinscription de chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Désabonnez-vous de chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Se désabonner de chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Désabonnez-vous de chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Se désabonner des participantsAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Se désabonner des participantsRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Désabonnez-vous de readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Désabonnez-vous de typingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Fonction d’abonnement pour chatMessageDeleted. L’expéditeur initial recevra également cet événement.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Fonction d’abonnement pour chatMessageEdited. L’expéditeur initial recevra également cet événement.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Fonction d’abonnement pour chatMessageReceived. L’expéditeur initial recevra également cet événement. Vous devez appeler startRealtimeNotifications avant de vous abonner à un événement.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Fonction Subscribe pour chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Fonction d’abonnement pour chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Fonction d’abonnement pour chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Fonction d’abonnement pour les participantsAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Fonction d’abonnement pour les participantsRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Fonction Subscribe pour readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Fonction Subscribe pour realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Fonction Subscribe pour realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Fonction Subscribe pour typingIndicatorReceived. L’expéditeur initial recevra également cet événement.
startRealtimeNotifications()	Commencez à recevoir des notifications en temps réel. Appelez cette fonction avant de vous abonner à un événement.
stopRealtimeNotifications()	Arrêtez de recevoir des notifications en temps réel. Cette fonction se désabonnerait de tous les événements.

Détails du constructeur

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crée une instance de ChatClient pour une ressource et un utilisateur donnés.

new ChatClient(endpoint: string, credential: CommunicationTokenCredential, options?: ChatClientOptions)

Paramètres

endpoint

string

URL de la ressource Communication Services.

credential

CommunicationTokenCredential

Informations d’identification du jeton. Utilisez AzureCommunicationTokenCredential à partir de @azure/communication-common pour créer des informations d’identification.

options

ChatClientOptions

Options clientes supplémentaires.

Détails de la méthode

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Crée un fil de conversation. Retourne le client de thread avec l’ID du thread créé.

function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

Paramètres

request

CreateChatThreadRequest

Demande de création d’un thread de conversation.

options

CreateChatThreadOptions

Options d’opération.

Retours

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Supprime un thread de conversation.

function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>

Paramètres

threadId

string

ID du thread à supprimer.

options

OperationOptions

Options d’opération.

Retours

Promise<void>

getChatThreadClient(string)

Retourne ChatThreadClient avec l’ID de thread spécifique.

function getChatThreadClient(threadId: string): ChatThreadClient

Paramètres

threadId

string

ID de thread pour ChatThreadClient

Retours

ChatThreadClient

listChatThreads(RestListChatThreadsOptions)

Obtient la liste des fils de conversation d’un utilisateur.

function listChatThreads(options?: RestListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Paramètres

options

RestListChatThreadsOptions

Répertorier les options des threads de conversation.

Retours

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Se désabonner de chatMessageDeleted.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Paramètres

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Écouteur pour gérer l’événement.

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Désinscription de chatMessageEdited.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Paramètres

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Écouteur pour gérer l’événement.

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Désinscription de chatMessageReceived.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Paramètres

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Écouteur pour gérer l’événement.

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Désabonnez-vous de chatThreadCreated.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Paramètres

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Écouteur pour gérer l’événement.

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Se désabonner de chatThreadDeleted.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Paramètres

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Écouteur pour gérer l’événement.

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Désabonnez-vous de chatThreadPropertiesUpdated.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Paramètres

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Écouteur pour gérer l’événement.

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

Se désabonner des participantsAdded.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Paramètres

event

"participantsAdded"

The ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Écouteur pour gérer l’événement.

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Se désabonner des participantsRemoved.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Paramètres

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Écouteur pour gérer l’événement.

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Désabonnez-vous de readReceiptReceived.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Paramètres

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Écouteur pour gérer l’événement.

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Désabonnez-vous de typingIndicatorReceived.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Paramètres

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Écouteur pour gérer l’événement.

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Fonction d’abonnement pour chatMessageDeleted. L’expéditeur initial recevra également cet événement.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Paramètres

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Écouteur pour gérer l’événement.

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Fonction d’abonnement pour chatMessageEdited. L’expéditeur initial recevra également cet événement.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Paramètres

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Écouteur pour gérer l’événement.

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Fonction d’abonnement pour chatMessageReceived. L’expéditeur initial recevra également cet événement. Vous devez appeler startRealtimeNotifications avant de vous abonner à un événement.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Paramètres

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Écouteur pour gérer l’événement.

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Fonction Subscribe pour chatThreadCreated.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Paramètres

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Écouteur pour gérer l’événement.

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Fonction d’abonnement pour chatThreadDeleted.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Paramètres

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Écouteur pour gérer l’événement.

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Fonction d’abonnement pour chatThreadPropertiesUpdated.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Paramètres

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Écouteur pour gérer l’événement.

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

Fonction d’abonnement pour les participantsAdded.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Paramètres

event

"participantsAdded"

The ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Écouteur pour gérer l’événement.

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Fonction d’abonnement pour les participantsRemoved.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Paramètres

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Écouteur pour gérer l’événement.

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Fonction Subscribe pour readReceiptReceived.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Paramètres

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Écouteur pour gérer l’événement.

on("realTimeNotificationConnected", () => void)

Fonction Subscribe pour realTimeNotificationConnected.

function on(event: "realTimeNotificationConnected", listener: () => void)

Paramètres

event

"realTimeNotificationConnected"

L’événement realTimeNotificationConnected

listener

() => void

Écouteur pour gérer l’événement.

on("realTimeNotificationDisconnected", () => void)

Fonction Subscribe pour realTimeNotificationDisconnected.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

Paramètres

event

"realTimeNotificationDisconnected"

L’événement realTimeNotificationDisconnected

listener

() => void

Écouteur pour gérer l’événement.

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Fonction Subscribe pour typingIndicatorReceived. L’expéditeur initial recevra également cet événement.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Paramètres

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Écouteur pour gérer l’événement.

startRealtimeNotifications()

Commencez à recevoir des notifications en temps réel. Appelez cette fonction avant de vous abonner à un événement.

function startRealtimeNotifications(): Promise<void>

Retours

Promise<void>

stopRealtimeNotifications()

Arrêtez de recevoir des notifications en temps réel. Cette fonction se désabonnerait de tous les événements.

function stopRealtimeNotifications(): Promise<void>

Retours

Promise<void>