ChatClient class

Paket:

@azure/communication-chat

Der Client zum Ausführen von Chatvorgängen

Konstruktoren

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Erstellt eine Instanz des ChatClients 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)	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)	Subscribe function for 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 zum Konstruktor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

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

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

Parameter

endpoint

string

Die URL der Kommunikationsdiensteressource.

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)

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.

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

Kündigen Sie das Abonnement von "chatMessageEdited".

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

Parameter

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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

Abmelden von chatMessageReceived.

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

Parameter

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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.

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

Kündigen Sie das Abonnement von "chatThreadPropertiesUpdated".

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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

Kündigen Sie das Abonnement von "participantsRemoved".

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

Parameter

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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

Kündigen Sie das Abonnement von readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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.

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"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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.

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

Subscribe function for chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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

Subscribe-Funktion für teilnehmerRemoved.

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

Parameter

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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

Subscribe-Funktion für readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Der Listener zum Behandeln des Ereignisses.

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.

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.

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.

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>

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Gibt zurück

Promise<void>