StatefulChatClient interface

Paket:

@azure/communication-react

Definiert die Methoden, mit denen {@Link @azure/communication-chat#ChatClient} mit einem zentralisierten generierten Zustand verwendet werden kann.

Die Schnittstelle bietet Zugriff auf den proxiierten Zustand und ermöglicht auch das Registrieren eines Handlers für Zustandsänderungsereignisse.

Extends

ChatClient

Methoden

dispose()	Bereinigt den Ressourcencache aus dem Chatthreadclient.
downloadResourceToCache(string, string, string)	Lädt eine Ressource für eine bestimmte Nachricht herunter und speichert sie zwischen.
getState()	Enthält den gesamten Status, den wir von ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState} proxyen können.
offStateChange((state: ChatClientState) => void)	Ermöglicht das Aufheben der Registrierung für "stateChanged"-Ereignisse.
onStateChange((state: ChatClientState) => void)	Ermöglicht die Registrierung eines Handlers für "stateChanged"-Ereignisse.
removeResourceFromCache(string, string, string)	Entfernt eine Ressource für eine bestimmte Nachricht aus dem Cache.

Geerbte Methoden

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Erstellt einen Chatthread. Gibt den Threadclient mit der ID des erstellten Threads zurück.
deleteChatThread(string, OperationOptions)	Löscht einen Chatthread.
getChatThreadClient(string)	Gibt ChatThreadClient mit der spezifischen Thread-ID zurück.
listChatThreads(ChatListChatThreadsOptionalParams)	Ruft die Liste der Chatthreads eines Benutzers ab.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Kündigen Sie das Abonnement von chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Kündigen Sie das Abonnement von "chatMessageEdited".
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Abmelden von chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Abmelden von "chatThreadCreated".
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Kündigen Sie das Abonnement von "chatThreadDeleted".
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Kündigen Sie das Abonnement von "chatThreadPropertiesUpdated".
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Abmelden von "participantsAdded".
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Kündigen Sie das Abonnement von "participantsRemoved".
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Kündigen Sie das Abonnement von readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Kündigen Sie das Abonnement von "typingIndicatorReceived".
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Abonnieren-Funktion für chatMessageDeleted. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Abonnieren-Funktion für chatMessageEdited. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Subscribe-Funktion für chatMessageReceived. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls. Sie müssen startRealtimeNotifications aufrufen, bevor Sie ein Ereignis abonnieren.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Abonnieren-Funktion für chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Subscribe-Funktion für chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Abonnieren-Funktion für chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Subscribe-Funktion für "participantsAdded".
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Subscribe-Funktion für teilnehmerRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Subscribe-Funktion für readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Subscribe-Funktion für realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Subscribe-Funktion für realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Subscribe-Funktion für typingIndicatorReceived. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.
startRealtimeNotifications()	Beginnen Sie mit dem Empfangen von Echtzeitbenachrichtigungen. Rufen Sie diese Funktion auf, bevor Sie ein Ereignis abonnieren.
stopRealtimeNotifications()	Beenden des Empfangens von Echtzeitbenachrichtigungen. Diese Funktion würde alle Ereignisse kündigen.

Details zur Methode

dispose()

Bereinigt den Ressourcencache aus dem Chatthreadclient.

function dispose()

downloadResourceToCache(string, string, string)

Lädt eine Ressource für eine bestimmte Nachricht herunter und speichert sie zwischen.

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

Parameter

threadId

string

Die Thread-ID des Chat-Threads.

messageId

string

Die Nachrichten-ID der Chatnachricht.

resourceUrl

string

Die Ressourcen-URL, die abgerufen und zwischengespeichert werden soll.

getState()

Enthält den gesamten Status, den wir von ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState} proxyen können.

function getState(): ChatClientState

Gibt zurück

ChatClientState

offStateChange((state: ChatClientState) => void)

Ermöglicht das Aufheben der Registrierung für "stateChanged"-Ereignisse.

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

Parameter

handler

(state: ChatClientState) => void

Ursprünglicher Rückruf, der abbestellt werden soll.

onStateChange((state: ChatClientState) => void)

Ermöglicht die Registrierung eines Handlers für "stateChanged"-Ereignisse.

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

Parameter

handler

(state: ChatClientState) => void

Rückruf zum Empfangen des Status.

removeResourceFromCache(string, string, string)

Entfernt eine Ressource für eine bestimmte Nachricht aus dem Cache.

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

Parameter

threadId

string

Die Thread-ID des Chat-Threads.

messageId

string

Die Nachrichten-ID der Chatnachricht.

resourceUrl

string

Die Ressourcen-URL, die aus dem Cache entfernt werden soll.

Details zur geerbten Methode

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Erstellt einen Chatthread. Gibt den Threadclient mit der ID des erstellten Threads zurück.

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

Parameter

request

CreateChatThreadRequest

Anforderung zum Erstellen eines Chatthreads.

options

CreateChatThreadOptions

Vorgangsoptionen.

Gibt zurück

Promise<CreateChatThreadResult>

geerbt von ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Löscht einen Chatthread.

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

Parameter

threadId

string

Die ID des zu löschenden Threads.

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>

geerbt von ChatClient.deleteChatThread

getChatThreadClient(string)

Gibt ChatThreadClient mit der spezifischen Thread-ID zurück.

function getChatThreadClient(threadId: string): ChatThreadClient

Parameter

threadId

string

Thread-ID für den ChatThreadClient

Gibt zurück

ChatThreadClient

Geerbt von ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Ruft die Liste der Chatthreads eines Benutzers ab.

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

Parameter

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Optionen für Chatthreads auflisten.

Gibt zurück

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Geerbt von ChatClient.listChatThreads

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

Kündigen Sie das Abonnement von chatMessageDeleted.

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

Parameter

event

"chatMessageDeleted"

Das ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von "chatMessageEdited".

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

Parameter

event

"chatMessageEdited"

Das ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Abmelden von chatMessageReceived.

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

Parameter

event

"chatMessageReceived"

Das ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Abmelden von "chatThreadCreated".

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

Parameter

event

"chatThreadCreated"

Das ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von "chatThreadDeleted".

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

Parameter

event

"chatThreadDeleted"

Das ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von "chatThreadPropertiesUpdated".

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

Parameter

event

"chatThreadPropertiesUpdated"

Das ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Abmelden von "participantsAdded".

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

Parameter

event

"participantsAdded"

"ParticipantsAddedEvent".

listener

(e: ParticipantsAddedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von "participantsRemoved".

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

Parameter

event

"participantsRemoved"

Das ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

Das ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Kündigen Sie das Abonnement von "typingIndicatorReceived".

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

Parameter

event

"typingIndicatorReceived"

Das TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.off

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

Abonnieren-Funktion für chatMessageDeleted. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.

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

Parameter

event

"chatMessageDeleted"

Das ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Abonnieren-Funktion für chatMessageEdited. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.

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

Parameter

event

"chatMessageEdited"

Das ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für chatMessageReceived. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls. Sie müssen startRealtimeNotifications aufrufen, bevor Sie ein Ereignis abonnieren.

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

Parameter

event

"chatMessageReceived"

Das ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Abonnieren-Funktion für chatThreadCreated.

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

Parameter

event

"chatThreadCreated"

Das ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

Das ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Abonnieren-Funktion für chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

Das ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für "participantsAdded".

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

Parameter

event

"participantsAdded"

"ParticipantsAddedEvent".

listener

(e: ParticipantsAddedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für teilnehmerRemoved.

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

Parameter

event

"participantsRemoved"

Das ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

Das ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für realTimeNotificationConnected.

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

Parameter

event

"realTimeNotificationConnected"

Das realTimeNotificationConnected-Ereignis

listener

() => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für realTimeNotificationDisconnected.

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

Parameter

event

"realTimeNotificationDisconnected"

Das realTimeNotificationDisconnected-Ereignis

listener

() => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

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

Subscribe-Funktion für typingIndicatorReceived. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.

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

Parameter

event

"typingIndicatorReceived"

Das TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

geerbt von ChatClient.on

startRealtimeNotifications()

Beginnen Sie mit dem Empfangen von Echtzeitbenachrichtigungen. Rufen Sie diese Funktion auf, bevor Sie ein Ereignis abonnieren.

function startRealtimeNotifications(): Promise<void>

Gibt zurück

Promise<void>

Geerbt von ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

Beenden des Empfangens von Echtzeitbenachrichtigungen. Diese Funktion würde alle Ereignisse kündigen.

function stopRealtimeNotifications(): Promise<void>

Gibt zurück

Promise<void>

Geerbt von ChatClient.stopRealtimeNotifications