ChatThreadClient class

Csomag:

@azure/communication-chat

Az ügyfél, aki csevegőműveleteket hajt végre

Konstruktorok

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Tulajdonságok

threadId

A ChatThreadClient szálazonosítója

Metódusok

addParticipants(AddParticipantsRequest, OperationOptions)	Hozzáadja a threadId által azonosított szálhoz tartozó csevegés résztvevőinek adatait.
deleteMessage(string, OperationOptions)	A threadId és a messageId által azonosított üzenet törlése
getMessage(string, OperationOptions)	Lekéri a messageId által azonosított csevegőüzenetet. Az adott üzenetet adja vissza.
getProperties(OperationOptions)	Csevegőszálat kap. A csevegési szálat adja vissza.
listMessages(ChatThreadListChatMessagesOptionalParams)	Lekéri a threadId által azonosított szál üzenetlistáját. Az üzenetek listáját adja vissza.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Lekéri a threadId által azonosított szál résztvevőit. A résztvevők listáját adja vissza.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Lekéri a threadId által azonosított szál olvasási nyugtájának listáját. Az üzenetek listáját adja vissza.
removeParticipant(CommunicationIdentifier, OperationOptions)	Eltávolítja a résztvevőt a threadId által azonosított szálból.
sendMessage(SendMessageRequest, SendMessageOptions)	Csevegőüzenetet küld a threadId által azonosított szálnak. A létrehozott üzenet azonosítóját adja vissza.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Olvasási visszaigazolást küld a threadId által azonosított szálnak.
sendTypingNotification(SendTypingNotificationOptions)	Gépelési értesítést küld a szálnak. Nem kísérli meg a küldést, ha az utolsó értesítés óta eltelt idő kisebb, mint a minimális gépelési időköz
updateMessage(string, UpdateMessageOptions)	A threadId és a messageId által azonosított üzenet frissítése
updateProperties(UpdateChatThreadPropertiesOptions)	Frissíti a szál tulajdonságait.
updateTopic(string, UpdateTopicOptions)	Frissíti egy szál témakörét.

Konstruktor adatai

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Paraméterek

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Tulajdonság adatai

threadId

A ChatThreadClient szálazonosítója

threadId: string

Tulajdonság értéke

string

Metódus adatai

addParticipants(AddParticipantsRequest, OperationOptions)

Hozzáadja a threadId által azonosított szálhoz tartozó csevegés résztvevőinek adatait.

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

Paraméterek

request

AddParticipantsRequest

A szál résztvevőinek a szálnévsorba felvenni kívánt adatai

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

A threadId és a messageId által azonosított üzenet törlése

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

Paraméterek

messageId

string

Az üzenet üzenetazonosítója.

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<void>

getMessage(string, OperationOptions)

Lekéri a messageId által azonosított csevegőüzenetet. Az adott üzenetet adja vissza.

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

Paraméterek

messageId

string

Az üzenet üzenetazonosítója.

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<ChatMessage>

getProperties(OperationOptions)

Csevegőszálat kap. A csevegési szálat adja vissza.

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

Paraméterek

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

Lekéri a threadId által azonosított szál üzenetlistáját. Az üzenetek listáját adja vissza.

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

Paraméterek

options

RestListMessagesOptions

Üzenetbeállítások lekérése.

Válaszok

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

Lekéri a threadId által azonosított szál résztvevőit. A résztvevők listáját adja vissza.

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

Paraméterek

options

RestListParticipantsOptions

Műveleti beállítások.

Válaszok

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

Lekéri a threadId által azonosított szál olvasási nyugtájának listáját. Az üzenetek listáját adja vissza.

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

Paraméterek

options

RestListReadReceiptsOptions

Üzenetbeállítások lekérése.

Válaszok

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Eltávolítja a résztvevőt a threadId által azonosított szálból.

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

Paraméterek

participant

CommunicationIdentifier

A szál résztvevője, amely eltávolítható a szálnévsorból

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Csevegőüzenetet küld a threadId által azonosított szálnak. A létrehozott üzenet azonosítóját adja vissza.

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

Paraméterek

request

SendMessageRequest

Üzenetküldési kérelem.

options

SendMessageOptions

Műveleti beállítások.

Válaszok

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Olvasási visszaigazolást küld a threadId által azonosított szálnak.

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

Paraméterek

request

SendReadReceiptRequest

Olvasási visszaigazolás küldésére vonatkozó kérelem

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Gépelési értesítést küld a szálnak. Nem kísérli meg a küldést, ha az utolsó értesítés óta eltelt idő kisebb, mint a minimális gépelési időköz

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

Paraméterek

options

SendTypingNotificationOptions

Műveleti beállítások

Válaszok

Promise<boolean>

Igaz, ha a gépelési üzenet értesítése elküldhető, ellenkező esetben hamis.

updateMessage(string, UpdateMessageOptions)

A threadId és a messageId által azonosított üzenet frissítése

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

Paraméterek

messageId

string

Az üzenet üzenetazonosítója.

options

UpdateMessageOptions

Műveleti beállítások.

Válaszok

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

Frissíti a szál tulajdonságait.

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

Paraméterek

options

UpdateChatThreadPropertiesOptions

Műveleti beállítások.

Válaszok

Promise<void>

updateTopic(string, UpdateTopicOptions)

Frissíti egy szál témakörét.

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

Paraméterek

topic

string

A témakört frissíteni kell.

options

UpdateTopicOptions

Műveleti beállítások.

Válaszok

Promise<void>