ChatThreadClient class

Paket:

@azure/communication-chat

Klien untuk melakukan operasi obrolan

Konstruktor

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Properti

threadId

ID Utas ChatThreadClient

Metode

addParticipants(AddParticipantsRequest, OperationOptions)	Menambahkan detail peserta obrolan milik utas yang diidentifikasi oleh threadId.
deleteMessage(string, OperationOptions)	Menghapus pesan yang diidentifikasi oleh threadId dan messageId
getMessage(string, OperationOptions)	Mendapatkan pesan obrolan yang diidentifikasi oleh messageId. Mengembalikan pesan tertentu.
getProperties(OperationOptions)	Mendapatkan utas obrolan. Mengembalikan utas obrolan.
listMessages(ChatThreadListChatMessagesOptionalParams)	Mendapatkan daftar pesan dari utas yang diidentifikasi oleh threadId. Mengembalikan daftar pesan.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Mendapatkan peserta utas yang diidentifikasi oleh threadId. Mengembalikan daftar peserta.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Mendapatkan daftar tanda terima baca dari utas yang diidentifikasi oleh threadId. Mengembalikan daftar pesan.
removeParticipant(CommunicationIdentifier, OperationOptions)	Menghapus peserta dari utas yang diidentifikasi oleh threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Mengirim pesan obrolan ke utas yang diidentifikasi oleh threadId. Mengembalikan id pesan yang dibuat.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Mengirim tanda terima baca ke utas yang diidentifikasi oleh threadId.
sendTypingNotification(SendTypingNotificationOptions)	Mengirim pemberitahuan pengetikan ke utas. Tidak mencoba mengirim jika waktu sejak pemberitahuan terakhir lebih kecil dari interval pengetikan minimum
updateMessage(string, UpdateMessageOptions)	Memperbarui pesan yang diidentifikasi oleh threadId dan messageId
updateProperties(UpdateChatThreadPropertiesOptions)	Memperbarui properti utas.
updateTopic(string, UpdateTopicOptions)	Memperbarui topik utas.

Detail Konstruktor

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Parameter

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Detail Properti

threadId

ID Utas ChatThreadClient

threadId: string

Nilai Properti

string

Detail Metode

addParticipants(AddParticipantsRequest, OperationOptions)

Menambahkan detail peserta obrolan milik utas yang diidentifikasi oleh threadId.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Parameter

request

AddParticipantsRequest

Detail peserta utas untuk ditambahkan dalam daftar utas

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Menghapus pesan yang diidentifikasi oleh threadId dan messageId

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Parameter

messageId

string

Id pesan pesan.

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<void>

getMessage(string, OperationOptions)

Mendapatkan pesan obrolan yang diidentifikasi oleh messageId. Mengembalikan pesan tertentu.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Parameter

messageId

string

Id pesan pesan.

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<ChatMessage>

getProperties(OperationOptions)

Mendapatkan utas obrolan. Mengembalikan utas obrolan.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Parameter

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

Mendapatkan daftar pesan dari utas yang diidentifikasi oleh threadId. Mengembalikan daftar pesan.

function listMessages(options?: ChatThreadListChatMessagesOptionalParams): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Parameter

options

RestListMessagesOptions

Dapatkan opsi pesan.

Mengembalikan

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

Mendapatkan peserta utas yang diidentifikasi oleh threadId. Mengembalikan daftar peserta.

function listParticipants(options?: ChatThreadListChatParticipantsOptionalParams): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Parameter

options

RestListParticipantsOptions

Opsi operasi.

Mengembalikan

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

Mendapatkan daftar tanda terima baca dari utas yang diidentifikasi oleh threadId. Mengembalikan daftar pesan.

function listReadReceipts(options?: ChatThreadListChatReadReceiptsOptionalParams): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Parameter

options

RestListReadReceiptsOptions

Dapatkan opsi pesan.

Mengembalikan

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Menghapus peserta dari utas yang diidentifikasi oleh threadId.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Parameter

participant

CommunicationIdentifier

Peserta utas untuk dihapus dari daftar utas

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Mengirim pesan obrolan ke utas yang diidentifikasi oleh threadId. Mengembalikan id pesan yang dibuat.

function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>

Parameter

request

SendMessageRequest

Permintaan untuk mengirim pesan.

options

SendMessageOptions

Opsi operasi.

Mengembalikan

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Mengirim tanda terima baca ke utas yang diidentifikasi oleh threadId.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Parameter

request

SendReadReceiptRequest

Permintaan untuk mengirim tanda terima baca

options

OperationOptions

Opsi operasi.

Mengembalikan

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Mengirim pemberitahuan pengetikan ke utas. Tidak mencoba mengirim jika waktu sejak pemberitahuan terakhir lebih kecil dari interval pengetikan minimum

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Parameter

options

SendTypingNotificationOptions

Opsi operasi

Mengembalikan

Promise<boolean>

True jika pemberitahuan pesan pengetikan dapat dikirim, jika tidak salah.

updateMessage(string, UpdateMessageOptions)

Memperbarui pesan yang diidentifikasi oleh threadId dan messageId

function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>

Parameter

messageId

string

Id pesan pesan.

options

UpdateMessageOptions

Opsi operasi.

Mengembalikan

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

Memperbarui properti utas.

function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>

Parameter

options

UpdateChatThreadPropertiesOptions

Opsi operasi.

Mengembalikan

Promise<void>

updateTopic(string, UpdateTopicOptions)

Memperbarui topik utas.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Parameter

topic

string

Topik perlu diperbarui.

options

UpdateTopicOptions

Opsi operasi.

Mengembalikan

Promise<void>