ChatThreadClient class

Klienten som ska utföra chattåtgärder

Konstruktorer

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Egenskaper

threadId

Tråd-ID för ChatThreadClient

Metoder

addParticipants(AddParticipantsRequest, OperationOptions)

Lägger till information om chattdeltagare som tillhör tråden som identifierats av threadId.

deleteMessage(string, OperationOptions)

Tar bort ett meddelande som identifieras av threadId och messageId

getMessage(string, OperationOptions)

Hämtar ett chattmeddelande som identifieras av messageId. Returnerar det specifika meddelandet.

getProperties(OperationOptions)

Hämtar en chatttråd. Returnerar chatttråden.

listMessages(RestListMessagesOptions)

Hämtar en lista över meddelanden från en tråd som identifierats av threadId. Returnerar listan över meddelanden.

listParticipants(RestListParticipantsOptions)

Hämtar deltagarna i tråden som identifieras av threadId. Returnerar listorna över deltagarna.

listReadReceipts(RestListReadReceiptsOptions)

Hämtar en lista över läskvitton från en tråd som identifierats av threadId. Returnerar listan över meddelanden.

removeParticipant(CommunicationIdentifier, OperationOptions)

Tar bort deltagare från tråden som identifieras av threadId.

sendMessage(SendMessageRequest, SendMessageOptions)

Skickar ett chattmeddelande till en tråd som identifieras av threadId. Returnerar ID:t för det skapade meddelandet.

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Skickar ett läskvitto till tråden som identifieras av threadId.

sendTypingNotification(SendTypingNotificationOptions)

Skickar ett skrivmeddelande till tråden. Försöker inte skicka om tiden sedan det senaste meddelandet är mindre än det minsta typningsintervallet

updateMessage(string, UpdateMessageOptions)

Uppdateringar ett meddelande som identifieras av threadId och messageId

updateTopic(string, UpdateTopicOptions)

Uppdateringar en tråds ämne.

Konstruktorinformation

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parametrar

endpoint

string

threadId

string

Egenskapsinformation

threadId

Tråd-ID för ChatThreadClient

threadId: string

Egenskapsvärde

string

Metodinformation

addParticipants(AddParticipantsRequest, OperationOptions)

Lägger till information om chattdeltagare som tillhör tråden som identifierats av threadId.

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

Parametrar

request
AddParticipantsRequest

Tråddeltagarnas information för att lägga till i trådlistan

options
OperationOptions

Åtgärdsalternativ.

Returer

deleteMessage(string, OperationOptions)

Tar bort ett meddelande som identifieras av threadId och messageId

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

Parametrar

messageId

string

Meddelandets meddelande-ID.

options
OperationOptions

Åtgärdsalternativ.

Returer

Promise<void>

getMessage(string, OperationOptions)

Hämtar ett chattmeddelande som identifieras av messageId. Returnerar det specifika meddelandet.

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

Parametrar

messageId

string

Meddelandets meddelande-ID.

options
OperationOptions

Åtgärdsalternativ.

Returer

Promise<ChatMessage>

getProperties(OperationOptions)

Hämtar en chatttråd. Returnerar chatttråden.

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

Parametrar

options
OperationOptions

Åtgärdsalternativ.

Returer

listMessages(RestListMessagesOptions)

Hämtar en lista över meddelanden från en tråd som identifierats av threadId. Returnerar listan över meddelanden.

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

Parametrar

options
RestListMessagesOptions

Hämta meddelandealternativ.

Returer

listParticipants(RestListParticipantsOptions)

Hämtar deltagarna i tråden som identifieras av threadId. Returnerar listorna över deltagarna.

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

Parametrar

options
RestListParticipantsOptions

Åtgärdsalternativ.

Returer

listReadReceipts(RestListReadReceiptsOptions)

Hämtar en lista över läskvitton från en tråd som identifierats av threadId. Returnerar listan över meddelanden.

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

Parametrar

options
RestListReadReceiptsOptions

Hämta meddelandealternativ.

Returer

removeParticipant(CommunicationIdentifier, OperationOptions)

Tar bort deltagare från tråden som identifieras av threadId.

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

Parametrar

participant
CommunicationIdentifier

Tråddeltagare att ta bort från trådlistan

options
OperationOptions

Åtgärdsalternativ.

Returer

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Skickar ett chattmeddelande till en tråd som identifieras av threadId. Returnerar ID:t för det skapade meddelandet.

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

Parametrar

request
SendMessageRequest

Begäran om att skicka ett meddelande.

options
SendMessageOptions

Åtgärdsalternativ.

Returer

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Skickar ett läskvitto till tråden som identifieras av threadId.

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

Parametrar

request
SendReadReceiptRequest

Begäran om att skicka ett läskvitto

options
OperationOptions

Åtgärdsalternativ.

Returer

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Skickar ett skrivmeddelande till tråden. Försöker inte skicka om tiden sedan det senaste meddelandet är mindre än det minsta typningsintervallet

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

Parametrar

options
SendTypingNotificationOptions

Åtgärdsalternativ

Returer

Promise<boolean>

Sant om det skrivna meddelandet kan skickas, annars falskt.

updateMessage(string, UpdateMessageOptions)

Uppdateringar ett meddelande som identifieras av threadId och messageId

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

Parametrar

messageId

string

Meddelandets meddelande-ID.

options
UpdateMessageOptions

Åtgärdsalternativ.

Returer

Promise<void>

updateTopic(string, UpdateTopicOptions)

Uppdateringar en tråds ämne.

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

Parametrar

topic

string

Ämnet måste uppdateras till.

options
UpdateTopicOptions

Åtgärdsalternativ.

Returer

Promise<void>