ChatThreadClient class

Paket:

@azure/communication-chat

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(ChatThreadListChatMessagesOptionalParams)	Hämtar en lista över meddelanden från en tråd som identifieras av threadId. Returnerar listan över meddelandena.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Hämtar deltagarna i tråden som identifieras av threadId. Returnerar listorna över deltagarna.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Hämtar en lista över läskvitto från en tråd som identifieras av threadId. Returnerar listan över meddelandena.
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 senaste meddelandet är mindre än det minsta typningsintervallet
updateMessage(string, UpdateMessageOptions)	Uppdaterar ett meddelande som identifieras av threadId och messageId
updateProperties(UpdateChatThreadPropertiesOptions)	Uppdaterar en tråds egenskaper.
updateTopic(string, UpdateTopicOptions)	Uppdaterar 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

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

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åddeltagares information att lägga till i trådlistan

options

OperationOptions

Åtgärdsalternativ.

Returer

Promise<AddChatParticipantsResult>

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

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

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

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

Parametrar

options

RestListMessagesOptions

Hämta meddelandealternativ.

Returer

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

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

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

Parametrar

options

RestListParticipantsOptions

Åtgärdsalternativ.

Returer

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

Hämtar en lista över läskvitto från en tråd som identifieras av threadId. Returnerar listan över meddelandena.

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

Parametrar

options

RestListReadReceiptsOptions

Hämta meddelandealternativ.

Returer

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

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

Promise<SendChatMessageResult>

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 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 kunde skickas, annars falskt.

updateMessage(string, UpdateMessageOptions)

Uppdaterar 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>

updateProperties(UpdateChatThreadPropertiesOptions)

Uppdaterar en tråds egenskaper.

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

Parametrar

options

UpdateChatThreadPropertiesOptions

Åtgärdsalternativ.

Returer

Promise<void>

updateTopic(string, UpdateTopicOptions)

Uppdaterar 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>