ChatClient class

Paket:

@azure/communication-chat

Der Client zum Ausführen von Chatvorgängen

Konstruktoren

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Erstellt eine Instanz des ChatClient für eine bestimmte Ressource und einen bestimmten Benutzer.

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)	Abmelden von chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Abmelden von chatMessageEd.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Abmelden von chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Abmelden von chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Abmelden von chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Abmelden von chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Von Teilnehmern abmeldenHinded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Teilnehmer abbestellenRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Abmelden von readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Abmelden von eingabeIndicatorReceived.
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)	Subscribe-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)	Subscribe-Funktion für TeilnehmerHinfügt.
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 die EingabeIndicatorReceived. 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 zum Konstruktor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Erstellt eine Instanz des ChatClient für eine bestimmte Ressource und einen bestimmten Benutzer.

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

Parameter

endpoint

string

Die URL der Communication Services-Ressource.

credential

CommunicationTokenCredential

Die Tokenanmeldeinformationen. Verwenden Sie AzureCommunicationTokenCredential aus @azure/communication-common , um Anmeldeinformationen zu erstellen.

options

ChatClientOptions

Zusätzliche Clientoptionen.

Details zur 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>

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>

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

listChatThreads(RestListChatThreadsOptions)

Ruft die Liste der Chatthreads eines Benutzers ab.

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

Parameter

options

RestListChatThreadsOptions

Optionen für Chatthreads auflisten.

Gibt zurück

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Abmelden von chatMessageDeleted.

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

Parameter

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Abmelden von chatMessageEd.

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

Parameter

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

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

Abmelden 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.

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

Abmelden von chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Abmelden von chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Von Teilnehmern abmeldenHinded.

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

Parameter

event

"participantsAdded"

Das ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Teilnehmer abbestellenRemoved.

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

Parameter

event

"participantsRemoved"

Das ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Abmelden 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.

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

Abmelden von eingabeIndicatorReceived.

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

Parameter

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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.

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

Subscribe-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.

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

Subscribe-Funktion für chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Subscribe-Funktion für chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener, der das Ereignis behandeln soll.

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

Subscribe-Funktion für TeilnehmerHinfü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.

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

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.

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.

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.

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

Subscribe-Funktion für die EingabeIndicatorReceived. 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.

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>

stopRealtimeNotifications()

Beenden sie den Empfang von Echtzeitbenachrichtigungen. Diese Funktion würde alle Ereignisse abbestellen.

function stopRealtimeNotifications(): Promise<void>

Gibt zurück

Promise<void>