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 Proxied-Zustand und ermöglicht auch die Registrierung eines Handlers für Zustandsänderungsereignisse.

Extends

ChatClient

Methoden

getState()	Enthält den gesamten Status, den wir von ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState} proxyn 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.

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(RestListChatThreadsOptions)	Ruft die Liste der Chatthreads eines Benutzers ab.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Kündigen von chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Kündigen von chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Kündigen von chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Kündigen von chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Kündigen von chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Kündigen von chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Abbestellen von TeilnehmernHinhingeleitet.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Teilnehmer kündigenRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Kündigen von readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Abbestellen von eingabeingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Subscribe-Funktion für chatMessageDeleted. Der ursprüngliche Absender empfängt dieses Ereignis ebenfalls.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Subscribe-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)	Subscribe-Funktion für chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Abonnieren-Funktion für TeilnehmerHinhinfügt.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Subscribe-Funktion für participantsRemoved.
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 Empfang von Echtzeitbenachrichtigungen. Rufen Sie diese Funktion auf, bevor Sie ein Ereignis abonnieren.
stopRealtimeNotifications()	Beenden sie den Empfang von Echtzeitbenachrichtigungen. Diese Funktion würde alle Ereignisse abbestellen.

Details zur Methode

getState()

Enthält den gesamten Status, den wir von ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState} proxyn 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, um den Status zu erhalten.

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(RestListChatThreadsOptions)

Ruft die Liste der Chatthreads eines Benutzers ab.

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

Parameter

options

RestListChatThreadsOptions

Listen von Optionen für Chatthreads auf.

Gibt zurück

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Geerbt von ChatClient.listChatThreads

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

Kündigen von chatMessageDeleted.

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

Parameter

event

"chatMessageDeleted"

Das ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von chatMessageEdited.

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

Parameter

event

"chatMessageEdited"

Das ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von chatMessageReceived.

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

Parameter

event

"chatMessageReceived"

Das ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von chatThreadCreated.

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

Parameter

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

Das ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

Das ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Abbestellen von TeilnehmernHinhingeleitet.

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

Parameter

event

"participantsAdded"

Das ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Teilnehmer kündigenRemoved.

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

Parameter

event

"participantsRemoved"

Das ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Kündigen von readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

Das ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Abbestellen von eingabeingIndicatorReceived.

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

Parameter

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.off

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

Subscribe-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, der das Ereignis behandeln soll.

Geerbt von ChatClient.on

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

Subscribe-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, der das Ereignis behandeln soll.

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, der das Ereignis behandeln soll.

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"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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, der das Ereignis behandeln soll.

Geerbt von ChatClient.on

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

Subscribe-Funktion für chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

Das ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.on

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

Abonnieren-Funktion für TeilnehmerHinhinfügt.

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

Parameter

event

"participantsAdded"

Das ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.on

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

Subscribe-Funktion für participantsRemoved.

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

Parameter

event

"participantsRemoved"

Das ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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, der das Ereignis behandeln soll.

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, der das Ereignis behandeln soll.

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, der das Ereignis behandeln soll.

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"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Der Listener, der das Ereignis behandeln soll.

Geerbt von ChatClient.on

startRealtimeNotifications()

Beginnen Sie mit dem Empfang 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 sie den Empfang von Echtzeitbenachrichtigungen. Diese Funktion würde alle Ereignisse abbestellen.

function stopRealtimeNotifications(): Promise<void>

Gibt zurück

Promise<void>

Geerbt von ChatClient.stopRealtimeNotifications