ChatThreadClient class

Pakket:

@azure/communication-chat

De client om chatbewerkingen uit te voeren

Constructors

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Eigenschappen

threadId

Thread-id van de ChatThreadClient

Methoden

addParticipants(AddParticipantsRequest, OperationOptions)	Voegt de details toe van chatdeelnemers die behoren tot de thread die is geïdentificeerd door threadId.
deleteMessage(string, OperationOptions)	Hiermee verwijdert u een bericht dat wordt geïdentificeerd door threadId en messageId
getMessage(string, OperationOptions)	Hiermee haalt u een chatbericht op dat wordt geïdentificeerd door messageId. Retourneert het specifieke bericht.
getProperties(OperationOptions)	Hiermee haalt u een chatgesprek op. Retourneert de chat-thread.
listMessages(ChatThreadListChatMessagesOptionalParams)	Hiermee haalt u een lijst met berichten op uit een thread die wordt geïdentificeerd door threadId. Retourneert de lijst met de berichten.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Haalt de deelnemers op van de thread die wordt geïdentificeerd door threadId. Retourneert de lijsten van de deelnemers.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Hiermee haalt u een lijst met leesbevestiging op van een thread die wordt geïdentificeerd door threadId. Retourneert de lijst met de berichten.
removeParticipant(CommunicationIdentifier, OperationOptions)	Hiermee verwijdert u de deelnemer uit de thread die is geïdentificeerd door threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Hiermee wordt een chatbericht verzonden naar een thread die wordt geïdentificeerd door threadId. Retourneert de id van het gemaakte bericht.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Hiermee wordt een leesbevestiging verzonden naar de thread die is geïdentificeerd door threadId.
sendTypingNotification(SendTypingNotificationOptions)	Hiermee wordt een melding voor het typen naar de thread verzonden. Probeert niet te verzenden als de tijd sinds de laatste melding kleiner is dan het minimale typeinterval
updateMessage(string, UpdateMessageOptions)	Hiermee werkt u een bericht bij dat wordt geïdentificeerd door threadId en messageId
updateProperties(UpdateChatThreadPropertiesOptions)	Hiermee worden de eigenschappen van een thread bijgewerkt.
updateTopic(string, UpdateTopicOptions)	Werkt het onderwerp van een thread bij.

Constructordetails

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parameters

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Eigenschapdetails

threadId

Thread-id van de ChatThreadClient

threadId: string

Waarde van eigenschap

string

Methodedetails

addParticipants(AddParticipantsRequest, OperationOptions)

Voegt de details toe van chatdeelnemers die behoren tot de thread die is geïdentificeerd door threadId.

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

Parameters

request

AddParticipantsRequest

Details van threaddeelnemers om toe te voegen aan het threadrooster

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Hiermee verwijdert u een bericht dat wordt geïdentificeerd door threadId en messageId

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

Parameters

messageId

string

De bericht-id van het bericht.

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<void>

getMessage(string, OperationOptions)

Hiermee haalt u een chatbericht op dat wordt geïdentificeerd door messageId. Retourneert het specifieke bericht.

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

Parameters

messageId

string

De bericht-id van het bericht.

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<ChatMessage>

getProperties(OperationOptions)

Hiermee haalt u een chatgesprek op. Retourneert de chat-thread.

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

Parameters

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

Hiermee haalt u een lijst met berichten op uit een thread die wordt geïdentificeerd door threadId. Retourneert de lijst met de berichten.

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

Parameters

options

RestListMessagesOptions

Opties voor berichten ophalen.

Retouren

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

Haalt de deelnemers op van de thread die wordt geïdentificeerd door threadId. Retourneert de lijsten van de deelnemers.

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

Parameters

options

RestListParticipantsOptions

Bewerkingsopties.

Retouren

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

Hiermee haalt u een lijst met leesbevestiging op van een thread die wordt geïdentificeerd door threadId. Retourneert de lijst met de berichten.

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

Parameters

options

RestListReadReceiptsOptions

Opties voor berichten ophalen.

Retouren

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Hiermee verwijdert u de deelnemer uit de thread die is geïdentificeerd door threadId.

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

Parameters

participant

CommunicationIdentifier

Threaddeelnemer die uit het threadrooster moet worden verwijderd

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Hiermee wordt een chatbericht verzonden naar een thread die wordt geïdentificeerd door threadId. Retourneert de id van het gemaakte bericht.

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

Parameters

request

SendMessageRequest

Verzoek om een bericht te verzenden.

options

SendMessageOptions

Bewerkingsopties.

Retouren

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Hiermee wordt een leesbevestiging verzonden naar de thread die is geïdentificeerd door threadId.

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

Parameters

request

SendReadReceiptRequest

Aanvraag voor het verzenden van een leesbevestiging

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Hiermee wordt een melding voor het typen naar de thread verzonden. Probeert niet te verzenden als de tijd sinds de laatste melding kleiner is dan het minimale typeinterval

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

Parameters

options

SendTypingNotificationOptions

Bewerkingsopties

Retouren

Promise<boolean>

Waar als de melding van het typebericht kan worden verzonden, anders onwaar.

updateMessage(string, UpdateMessageOptions)

Hiermee werkt u een bericht bij dat wordt geïdentificeerd door threadId en messageId

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

Parameters

messageId

string

De bericht-id van het bericht.

options

UpdateMessageOptions

Bewerkingsopties.

Retouren

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

Hiermee worden de eigenschappen van een thread bijgewerkt.

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

Parameters

options

UpdateChatThreadPropertiesOptions

Bewerkingsopties.

Retouren

Promise<void>

updateTopic(string, UpdateTopicOptions)

Werkt het onderwerp van een thread bij.

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

Parameters

topic

string

Het onderwerp moet worden bijgewerkt naar.

options

UpdateTopicOptions

Bewerkingsopties.

Retouren

Promise<void>