StatefulChatClient interface

Paquet:

@azure/communication-react

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

L’interface permet d’accéder à l’état proxié et permet également d’inscrire un gestionnaire pour les événements de modification d’état.

Extends

ChatClient

Méthodes

dispose()	Nettoie le cache de ressources du client de fil de discussion.
downloadResourceToCache(string, string, string)	Télécharge une ressource pour un message spécifique et la met en cache.
getState()	Contient tout l’état que nous pourrions proxyer à partir de ChatClient {@Link @azure/communication-chat#ChatClient} en tant que ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Autorise l’annulation de l’inscription pour les événements « stateChanged ».
onStateChange((state: ChatClientState) => void)	Permet à un gestionnaire d’être inscrit pour les événements « stateChanged ».
removeResourceFromCache(string, string, string)	Supprime une ressource du cache pour un message spécifique.

Méthodes héritées

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Crée un thread 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(ChatListChatThreadsOptionalParams)	Obtient la liste des threads de conversation d’un utilisateur.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Désinscrivez-vous de chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Désinscrivez-vous de chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Désabonnez-vous de chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Désinscrivez-vous de chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Désinscrivez-vous de chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Désabonnez-vous de chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Désinscrivez-vous des participantsAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Désinscrivez-vous des participantsRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Désabonnez-vous de readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Désabonnez-vous de la saisie deIndicatorReceived.
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 Subscribe pour chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Fonction Subscribe pour chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Fonction d’abonnement pour les participantsAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Fonction d’abonnement pour participantsRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Fonction d’abonnement pour readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Fonction Subscribe pour realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Fonction Subscribe pour realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Fonction Subscribe pour taperIndicatorReceived. 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 de la méthode

dispose()

Nettoie le cache de ressources du client de fil de discussion.

function dispose()

downloadResourceToCache(string, string, string)

Télécharge une ressource pour un message spécifique et la met en cache.

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

Paramètres

threadId

string

L’identifiant du fil de discussion.

messageId

string

L’identifiant du message de chat.

resourceUrl

string

URL de la ressource à récupérer et à mettre en cache.

getState()

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

function getState(): ChatClientState

Retours

ChatClientState

offStateChange((state: ChatClientState) => void)

Autorise l’annulation de l’inscription pour les événements « stateChanged ».

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

Paramètres

handler

(state: ChatClientState) => void

Rappel d’origine à annuler.

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.

removeResourceFromCache(string, string, string)

Supprime une ressource du cache pour un message spécifique.

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

Paramètres

threadId

string

L’identifiant du fil de discussion.

messageId

string

L’identifiant du message de chat.

resourceUrl

string

URL de la ressource à supprimer du cache.

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

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Crée un thread 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ée de ChatClient.createChatThread

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>

héritée de ChatClient.deleteChatThread

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

héritée de ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

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

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

Paramètres

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Répertorier les options des threads de conversation.

Retours

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

héritée de ChatClient.listChatThreads

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

Désinscrivez-vous de chatMessageDeleted.

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

Paramètres

event

"chatMessageDeleted"

L’événement ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

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

héritée de ChatClient.off

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

Désinscrivez-vous de chatMessageEdited.

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

Paramètres

event

"chatMessageEdited"

L’événement ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

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

héritée de ChatClient.off

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

Désabonnez-vous de chatMessageReceived.

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

Paramètres

event

"chatMessageReceived"

L’événement ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

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

héritée de ChatClient.off

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

Désinscrivez-vous de chatThreadCreated.

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

Paramètres

event

"chatThreadCreated"

L’événement ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

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

héritée de ChatClient.off

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

Désinscrivez-vous de chatThreadDeleted.

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

Paramètres

event

"chatThreadDeleted"

L’événement ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

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

héritée de ChatClient.off

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

Désabonnez-vous de chatThreadPropertiesUpdated.

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

Paramètres

event

"chatThreadPropertiesUpdated"

L’événement ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

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

héritée de ChatClient.off

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

Désinscrivez-vous des participantsAdded.

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

Paramètres

event

"participantsAdded"

L’événement ParticipantsAdded.

listener

(e: ParticipantsAddedEvent) => void

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

héritée de ChatClient.off

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

Désinscrivez-vous des participantsRemoved.

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

Paramètres

event

"participantsRemoved"

L’événement ParticipantsRemoved.

listener

(e: ParticipantsRemovedEvent) => void

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

héritée de ChatClient.off

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

Désabonnez-vous de readReceiptReceived.

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

Paramètres

event

"readReceiptReceived"

L’événement ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

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

héritée de ChatClient.off

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

Désabonnez-vous de la saisie deIndicatorReceived.

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

Paramètres

event

"typingIndicatorReceived"

L’événement TypingIndicatorReceived.

listener

(e: TypingIndicatorReceivedEvent) => void

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

héritée 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"

L’événement ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

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

héritée 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"

L’événement ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

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

héritée 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"

L’événement ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

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

héritée 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"

L’événement ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

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

héritée de ChatClient.on

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

Fonction Subscribe pour chatThreadDeleted.

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

Paramètres

event

"chatThreadDeleted"

L’événement ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

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

héritée de ChatClient.on

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

Fonction Subscribe pour chatThreadPropertiesUpdated.

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

Paramètres

event

"chatThreadPropertiesUpdated"

L’événement ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

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

héritée 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"

L’événement ParticipantsAdded.

listener

(e: ParticipantsAddedEvent) => void

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

héritée de ChatClient.on

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

Fonction d’abonnement pour participantsRemoved.

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

Paramètres

event

"participantsRemoved"

L’événement ParticipantsRemoved.

listener

(e: ParticipantsRemovedEvent) => void

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

héritée 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"

L’événement ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

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

héritée de ChatClient.on

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.

héritée de ChatClient.on

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.

héritée de ChatClient.on

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

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

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

Paramètres

event

"typingIndicatorReceived"

L’événement TypingIndicatorReceived.

listener

(e: TypingIndicatorReceivedEvent) => void

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

héritée de ChatClient.on

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>

héritée de ChatClient.startRealtimeNotifications

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>

héritée de ChatClient.stopRealtimeNotifications