StatefulChatClient interface

Paket:

@azure/communication-react

Menentukan metode yang memungkinkan {@Link @azure/communication-chat#ChatClient} digunakan dengan status terpusat yang dihasilkan.

Antarmuka menyediakan akses ke status diproksi dan juga memungkinkan mendaftarkan handler untuk peristiwa perubahan status.

Memperluas

ChatClient

Metode

dispose()	Membersihkan cache sumber daya dari klien utas obrolan.
downloadResourceToCache(string, string, string)	Mendownload sumber daya untuk pesan tertentu dan menyimpan dalam cache.
getState()	Menyimpan semua status yang dapat kita proksi dari ChatClient {@Link @azure/communication-chat#ChatClient} sebagai ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Memungkinkan membatalkan pendaftaran untuk peristiwa 'stateChanged'.
onStateChange((state: ChatClientState) => void)	Memungkinkan handler didaftarkan untuk peristiwa 'stateChanged'.
removeResourceFromCache(string, string, string)	Menghapus sumber daya dari cache untuk pesan tertentu.

Metode yang Diwarisi

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(ChatListChatThreadsOptionalParams)	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 ke peristiwa apa pun.
stopRealtimeNotifications()	Berhenti menerima pemberitahuan realtime. Fungsi ini akan berhenti berlangganan semua peristiwa.

Detail Metode

dispose()

Membersihkan cache sumber daya dari klien utas obrolan.

function dispose()

downloadResourceToCache(string, string, string)

Mendownload sumber daya untuk pesan tertentu dan menyimpan dalam cache.

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

Parameter

threadId

string

ID utas utas obrolan.

messageId

string

ID pesan pesan obrolan.

resourceUrl

string

URL sumber daya untuk diambil dan di-cache.

getState()

Menyimpan semua status yang dapat kita proksi dari ChatClient {@Link @azure/communication-chat#ChatClient} sebagai ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Mengembalikan

ChatClientState

offStateChange((state: ChatClientState) => void)

Memungkinkan membatalkan pendaftaran untuk peristiwa 'stateChanged'.

function offStateChange(handler: (state: ChatClientState) => void)

Parameter

handler

(state: ChatClientState) => void

Panggilan balik asli untuk berhenti berlangganan.

onStateChange((state: ChatClientState) => void)

Memungkinkan handler didaftarkan untuk peristiwa 'stateChanged'.

function onStateChange(handler: (state: ChatClientState) => void)

Parameter

handler

(state: ChatClientState) => void

Panggilan balik untuk menerima status.

removeResourceFromCache(string, string, string)

Menghapus sumber daya dari cache untuk pesan tertentu.

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

Parameter

threadId

string

ID utas utas obrolan.

messageId

string

ID pesan pesan obrolan.

resourceUrl

string

URL sumber daya untuk dihapus dari cache.

Detail Metode yang Diwarisi

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>

Diwarisi Dari ChatClient.createChatThread

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>

Diwarisi Dari ChatClient.deleteChatThread

getChatThreadClient(string)

Mengembalikan ChatThreadClient dengan id utas tertentu.

function getChatThreadClient(threadId: string): ChatThreadClient

Parameter

threadId

string

ID Utas untuk ChatThreadClient

Mengembalikan

ChatThreadClient

Diwarisi Dari ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Mendapatkan daftar utas obrolan pengguna.

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

Parameter

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Mencantumkan opsi utas obrolan.

Mengembalikan

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Diwariskan Dari ChatClient.listChatThreads

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

Berhenti berlangganan dari chatMessageDeleted.

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

Parameter

event

"chatMessageDeleted"

Peristiwa ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.off

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

Berhenti berlangganan dari chatMessageEdited.

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

Parameter

event

"chatMessageEdited"

Peristiwa ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.off

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

Berhenti berlangganan dari chatMessageReceived.

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

Parameter

event

"chatMessageReceived"

Peristiwa ChatMessageReceived.

listener

(e: ChatMessageReceivedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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

Berhenti berlangganan dari chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

Peristiwa ChatThreadDeleted.

listener

(e: ChatThreadDeletedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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.

Diwariskan Dari ChatClient.off

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"

Peristiwa ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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"

Peristiwa ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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"

Peristiwa ChatMessageReceived.

listener

(e: ChatMessageReceivedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

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

Berlangganan fungsi untuk chatThreadDeleted.

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

Parameter

event

"chatThreadDeleted"

Peristiwa ChatThreadDeleted.

listener

(e: ChatThreadDeletedEvent) => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

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

Berlangganan fungsi untuk realTimeNotificationConnected.

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

Parameter

event

"realTimeNotificationConnected"

Kejadian realTimeNotificationConnected

listener

() => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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

Berlangganan fungsi untuk realTimeNotificationDisconnected.

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

Parameter

event

"realTimeNotificationDisconnected"

Kejadian realTimeNotificationDisconnected

listener

() => void

Pendengar untuk menangani peristiwa.

Diwariskan Dari ChatClient.on

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.

Diwariskan Dari ChatClient.on

startRealtimeNotifications()

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

function startRealtimeNotifications(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan Dari ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan Dari ChatClient.stopRealtimeNotifications