ChatClient class

Pakiet:

@azure/communication-chat

Klient do wykonywania operacji czatu

Konstruktory

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Tworzy wystąpienie obiektu ChatClient dla danego zasobu i użytkownika.

Metody

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Tworzy wątek czatu. Zwraca klienta wątku o identyfikatorze utworzonego wątku.
deleteChatThread(string, OperationOptions)	Usuwa wątek czatu.
getChatThreadClient(string)	Zwraca element ChatThreadClient z określonym identyfikatorem wątku.
listChatThreads(RestListChatThreadsOptions)	Pobiera listę wątków czatu użytkownika.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Anuluj subskrypcję chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Anuluj subskrypcję chatMessageEdytuj.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Anuluj subskrypcję chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Anuluj subskrypcję czatUtwórz.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Anuluj subskrypcję czatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Anuluj subskrypcję czatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Anuluj subskrypcję uczestnikówDodaj.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Anuluj subskrypcję uczestnikówReoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Anuluj subskrypcję readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Anuluj subskrypcję z wpisywania wpisaćIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Subskrybuj funkcję chatMessageDeleted. Początkowy nadawca otrzyma również to zdarzenie.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Subskrybuj funkcję chatMessageEdited. Początkowy nadawca otrzyma również to zdarzenie.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Subskrybuj funkcję chatMessageReceived. Początkowy nadawca otrzyma również to zdarzenie. Przed zasubskrybowaniem dowolnego zdarzenia należy wywołać metodę startRealtimeNotifications.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Funkcja subskrybuj czatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Subskrybuj funkcję chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Subskrybuj funkcję chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Subskrybuj funkcję dla uczestnikówDodaj.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Funkcja Subskrybuj dla uczestnikówRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Funkcja subskrybuj dla funkcji readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Funkcja subskrybuj dla funkcji realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Funkcja subskrybuj dla funkcji realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Funkcja Subskrybuj dla wpisywania elementuIndicatorReceived. Początkowy nadawca otrzyma również to zdarzenie.
startRealtimeNotifications()	Zacznij otrzymywać powiadomienia w czasie rzeczywistym. Wywołaj tę funkcję przed zasubskrybowaniem dowolnego zdarzenia.
stopRealtimeNotifications()	Przestań otrzymywać powiadomienia w czasie rzeczywistym. Ta funkcja anuluje subskrypcję wszystkich zdarzeń.

Szczegóły konstruktora

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Tworzy wystąpienie obiektu ChatClient dla danego zasobu i użytkownika.

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

Parametry

endpoint

string

Adres URL zasobu usług komunikacyjnych.

credential

CommunicationTokenCredential

Poświadczenia tokenu. Użyj polecenia AzureCommunicationTokenCredential z @azure/communication-common , aby utworzyć poświadczenie.

options

ChatClientOptions

Dodatkowe opcje klienta.

Szczegóły metody

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Tworzy wątek czatu. Zwraca klienta wątku o identyfikatorze utworzonego wątku.

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

Parametry

request

CreateChatThreadRequest

Żądanie utworzenia wątku czatu.

options

CreateChatThreadOptions

Opcje operacji.

Zwraca

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Usuwa wątek czatu.

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

Parametry

threadId

string

Identyfikator wątku do usunięcia.

options

OperationOptions

Opcje operacji.

Zwraca

Promise<void>

getChatThreadClient(string)

Zwraca element ChatThreadClient z określonym identyfikatorem wątku.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametry

threadId

string

Identyfikator wątku elementu ChatThreadClient

Zwraca

ChatThreadClient

listChatThreads(RestListChatThreadsOptions)

Pobiera listę wątków czatu użytkownika.

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

Parametry

options

RestListChatThreadsOptions

Opcje wątków czatu listy.

Zwraca

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Anuluj subskrypcję chatMessageDeleted.

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

Parametry

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję chatMessageEdytuj.

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

Parametry

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję chatMessageReceived.

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

Parametry

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję czatUtwórz.

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

Parametry

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję czatThreadDeleted.

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

Parametry

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję czatThreadPropertiesUpdated.

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

Parametry

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję uczestnikówDodaj.

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

Parametry

event

"participantsAdded"

UczestnicyAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję uczestnikówReoved.

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

Parametry

event

"participantsRemoved"

UczestnicyRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję readReceiptReceived.

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

Parametry

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Anuluj subskrypcję z wpisywania wpisaćIndicatorReceived.

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

Parametry

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję chatMessageDeleted. Początkowy nadawca otrzyma również to zdarzenie.

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

Parametry

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję chatMessageEdited. Początkowy nadawca otrzyma również to zdarzenie.

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

Parametry

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję chatMessageReceived. Początkowy nadawca otrzyma również to zdarzenie. Przed zasubskrybowaniem dowolnego zdarzenia należy wywołać metodę startRealtimeNotifications.

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

Parametry

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Funkcja subskrybuj czatThreadCreated.

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

Parametry

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję chatThreadDeleted.

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

Parametry

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję chatThreadPropertiesUpdated.

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

Parametry

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Subskrybuj funkcję dla uczestnikówDodaj.

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

Parametry

event

"participantsAdded"

UczestnicyAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Funkcja Subskrybuj dla uczestnikówRemoved.

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

Parametry

event

"participantsRemoved"

UczestnicyRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Funkcja subskrybuj dla funkcji readReceiptReceived.

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

Parametry

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

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

Funkcja subskrybuj dla funkcji realTimeNotificationConnected.

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

Parametry

event

"realTimeNotificationConnected"

Zdarzenie realTimeNotificationConnected

listener

() => void

Odbiornik do obsługi zdarzenia.

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

Funkcja subskrybuj dla funkcji realTimeNotificationDisconnected.

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

Parametry

event

"realTimeNotificationDisconnected"

Zdarzenie realTimeNotificationDisconnected

listener

() => void

Odbiornik do obsługi zdarzenia.

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

Funkcja Subskrybuj dla wpisywania elementuIndicatorReceived. Początkowy nadawca otrzyma również to zdarzenie.

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

Parametry

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Odbiornik do obsługi zdarzenia.

startRealtimeNotifications()

Zacznij otrzymywać powiadomienia w czasie rzeczywistym. Wywołaj tę funkcję przed zasubskrybowaniem dowolnego zdarzenia.

function startRealtimeNotifications(): Promise<void>

Zwraca

Promise<void>

stopRealtimeNotifications()

Przestań otrzymywać powiadomienia w czasie rzeczywistym. Ta funkcja anuluje subskrypcję wszystkich zdarzeń.

function stopRealtimeNotifications(): Promise<void>

Zwraca

Promise<void>