ChatClient class

Paket:

@azure/communication-chat

Klien untuk melakukan operasi obrolan

Konstruktor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Membuat instans ChatClient untuk sumber daya dan pengguna tertentu.

Metode

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Membuat utas obrolan. Mengembalikan klien utas dengan id utas yang dibuat.
deleteChatThread(string, OperationOptions)	Menghapus utas obrolan.
getChatThreadClient(string)	Mengembalikan ChatThreadClient dengan id utas tertentu.
listChatThreads(RestListChatThreadsOptions)	Mendapatkan daftar utas obrolan pengguna.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Berhenti berlangganan dari chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Berhenti berlangganan dari chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Berhenti berlangganan dari chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Berhenti berlangganan dari chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Berhenti berlangganan dari chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Berhenti berlangganan dari chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Berhenti berlangganan dari pesertaTambahkan.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Berhenti berlangganan dari pesertaRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Berhenti berlangganan dari readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Berhenti berlangganan dari typingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Berlangganan fungsi untuk chatMessageDeleted. Pengirim awal juga akan menerima kejadian ini.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Berlangganan fungsi untuk chatMessageEdited. Pengirim awal juga akan menerima kejadian ini.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Berlangganan fungsi untuk chatMessageReceived. Pengirim awal juga akan menerima kejadian ini. Anda perlu memanggil startRealtimeNotifications sebelum berlangganan peristiwa apa pun.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Berlangganan fungsi untuk chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Berlangganan fungsi untuk chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Berlangganan fungsi untuk chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Berlangganan fungsi untuk pesertaTambahkan.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Berlangganan fungsi untuk pesertaRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Berlangganan fungsi untuk readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Berlangganan fungsi untuk realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Berlangganan fungsi untuk realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Berlangganan fungsi untuk typingIndicatorReceived. Pengirim awal juga akan menerima kejadian ini.
startRealtimeNotifications()	Mulai menerima pemberitahuan realtime. Panggil fungsi ini sebelum berlangganan peristiwa apa pun.
stopRealtimeNotifications()	Berhenti menerima pemberitahuan realtime. Fungsi ini akan berhenti berlangganan semua peristiwa.

Detail Konstruktor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Membuat instans ChatClient untuk sumber daya dan pengguna tertentu.

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

Parameter

endpoint

string

Url sumber daya Communication Services.

credential

CommunicationTokenCredential

Kredensial token. Gunakan AzureCommunicationTokenCredential dari @azure/communication-common untuk membuat kredensial.

options

ChatClientOptions

Opsi klien tambahan.

Detail Metode

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Membuat utas obrolan. Mengembalikan klien utas dengan id utas yang dibuat.

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

Parameter

request

CreateChatThreadRequest

Permintaan untuk membuat utas obrolan.

options

CreateChatThreadOptions

Opsi operasi.

Mengembalikan

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Menghapus utas obrolan.

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

Parameter

threadId

string

ID utas yang akan dihapus.

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<void>

getChatThreadClient(string)

Mengembalikan ChatThreadClient dengan id utas tertentu.

function getChatThreadClient(threadId: string): ChatThreadClient

Parameter

threadId

string

ID Utas untuk ChatThreadClient

Mengembalikan

ChatThreadClient

listChatThreads(RestListChatThreadsOptions)

Mendapatkan daftar utas obrolan pengguna.

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

Parameter

options

RestListChatThreadsOptions

Mencantumkan opsi utas obrolan.

Mengembalikan

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Berhenti berlangganan dari chatMessageDeleted.

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

Parameter

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari chatMessageEdited.

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

Parameter

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari chatMessageReceived.

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

Parameter

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari chatThreadCreated.

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

Parameter

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari pesertaTambahkan.

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

Parameter

event

"participantsAdded"

PesertaAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari pesertaRemoved.

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

Parameter

event

"participantsRemoved"

PesertaRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berhenti berlangganan dari typingIndicatorReceived.

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

Parameter

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatMessageDeleted. Pengirim awal juga akan menerima kejadian ini.

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

Parameter

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatMessageEdited. Pengirim awal juga akan menerima kejadian ini.

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

Parameter

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatMessageReceived. Pengirim awal juga akan menerima kejadian ini. Anda perlu memanggil startRealtimeNotifications sebelum berlangganan peristiwa apa pun.

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

Parameter

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatThreadCreated.

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

Parameter

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk chatThreadPropertiesUpdated.

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

Parameter

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk pesertaTambahkan.

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

Parameter

event

"participantsAdded"

PesertaAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk pesertaRemoved.

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

Parameter

event

"participantsRemoved"

PesertaRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk readReceiptReceived.

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

Parameter

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk realTimeNotificationConnected.

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

Parameter

event

"realTimeNotificationConnected"

Kejadian realTimeNotificationConnected

listener

() => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk realTimeNotificationDisconnected.

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

Parameter

event

"realTimeNotificationDisconnected"

Kejadian realTimeNotificationDisconnected

listener

() => void

Pendengar untuk menangani peristiwa.

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

Berlangganan fungsi untuk typingIndicatorReceived. Pengirim awal juga akan menerima kejadian ini.

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

Parameter

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Pendengar untuk menangani peristiwa.

startRealtimeNotifications()

Mulai menerima pemberitahuan realtime. Panggil fungsi ini sebelum berlangganan peristiwa apa pun.

function startRealtimeNotifications(): Promise<void>

Mengembalikan

Promise<void>

stopRealtimeNotifications()

Berhenti menerima pemberitahuan realtime. Fungsi ini akan berhenti berlangganan semua peristiwa.

function stopRealtimeNotifications(): Promise<void>

Mengembalikan

Promise<void>