StatefulChatClient interface

Paquet:

@azure/communication-react

Définit les méthodes qui permettent d’utiliser {@Link @azure/communication-chat#ChatClient} avec un état généré centralisé.

L’interface fournit l’accès à l’état proxié et permet également d’inscrire un gestionnaire pour les événements de changement d’état.

Extends

ChatClient

Méthodes

getState()	Contient tout l’état que nous pourrions proxy à partir de ChatClient {@Link @azure/communication-chat#ChatClient} en tant que ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Autorise la désinscription des événements « stateChanged ».
onStateChange((state: ChatClientState) => void)	Permet à un gestionnaire d’être inscrit pour les événements « stateChanged ».

Méthodes héritées

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 fil de conversation.
getChatThreadClient(string)	Renvoie 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ésinscription de chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Se désabonner de chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Désinscription de chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Désinscription des participantsAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Désinscription des participantsSupprimé.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Désinscrivez-vous de readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Désinscription 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 d’abonnement 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 participantsSupprimé.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Fonction d’abonnement pour readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Fonction d’abonnement pour realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Fonction d’abonnement pour realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Fonction d’abonnement 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 à n’importe quel événement.
stopRealtimeNotifications()	Arrêtez de recevoir des notifications en temps réel. Cette fonction se désinscrit de tous les événements.

Détails de la méthode

getState()

Contient tout l’état que nous pourrions proxy à partir de ChatClient {@Link @azure/communication-chat#ChatClient} en tant que ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Retours

ChatClientState

offStateChange((state: ChatClientState) => void)

Autorise la désinscription des événements « stateChanged ».

function offStateChange(handler: (state: ChatClientState) => void)

Paramètres

handler

(state: ChatClientState) => void

Rappel d’origine à désinscrire.

onStateChange((state: ChatClientState) => void)

Permet à un gestionnaire d’être inscrit pour les événements « stateChanged ».

function onStateChange(handler: (state: ChatClientState) => void)

Paramètres

handler

(state: ChatClientState) => void

Rappel pour recevoir l’état.

Détails de la méthode héritée

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>

Hérité de ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Supprime un fil 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>

Hérité de ChatClient.deleteChatThread

getChatThreadClient(string)

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

function getChatThreadClient(threadId: string): ChatThreadClient

Paramètres

threadId

string

ID de thread pour ChatThreadClient

Retours

ChatThreadClient

Hérité de ChatClient.getChatThreadClient

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>

Hérité de ChatClient.listChatThreads

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.

Hérité de ChatClient.off

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.

Hérité de ChatClient.off

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.

Hérité de ChatClient.off

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

Désinscription 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.

Hérité de ChatClient.off

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.

Hérité de ChatClient.off

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

Désinscription 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.

Hérité de ChatClient.off

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

Désinscription 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.

Hérité de ChatClient.off

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

Désinscription des participantsSupprimé.

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.

Hérité de ChatClient.off

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

Désinscrivez-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.

Hérité de ChatClient.off

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

Désinscription 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.

Hérité de ChatClient.off

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.

Hérité de ChatClient.on

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.

Hérité de ChatClient.on

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.

Hérité de ChatClient.on

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

Fonction d’abonnement 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.

Hérité de ChatClient.on

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.

Hérité de ChatClient.on

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.

Hérité de ChatClient.on

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.

Hérité de ChatClient.on

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

Fonction d’abonnement pour les participantsSupprimé.

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.

Hérité de ChatClient.on

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

Fonction d’abonnement 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.

Hérité de ChatClient.on

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

Fonction d’abonnement pour realTimeNotificationConnected.

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

Paramètres

event

"realTimeNotificationConnected"

Événement realTimeNotificationConnected

listener

() => void

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

Hérité de ChatClient.on

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

Fonction d’abonnement pour realTimeNotificationDisconnected.

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

Paramètres

event

"realTimeNotificationDisconnected"

Événement realTimeNotificationDisconnected

listener

() => void

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

Hérité de ChatClient.on

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

Fonction d’abonnement 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.

Hérité de ChatClient.on

startRealtimeNotifications()

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

function startRealtimeNotifications(): Promise<void>

Retours

Promise<void>

Hérité de ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Retours

Promise<void>

Hérité de ChatClient.stopRealtimeNotifications