ChatThreadClient class

Balíček:

@azure/communication-chat

Klient, který má provádět operace chatu

Konstruktory

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Vlastnosti

threadId

ID vlákna ChatThreadClient

Metody

addParticipants(AddParticipantsRequest, OperationOptions)	Přidá podrobnosti o účastnících chatu patřících do vlákna identifikovaného id vlákna.
deleteMessage(string, OperationOptions)	Odstraní zprávu identifikovanou pomocí threadId a messageId.
getMessage(string, OperationOptions)	Získá chatovou zprávu identifikovanou podle messageId. Vrátí konkrétní zprávu.
getProperties(OperationOptions)	Získá vlákno chatu. Vrátí vlákno chatu.
listMessages(ChatThreadListChatMessagesOptionalParams)	Získá seznam zpráv z vlákna identifikovaného threadId. Vrátí seznam zpráv.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Získá účastníky vlákna identifikované threadId. Vrátí seznamy účastníků.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Získá seznam potvrzení o přečtení z vlákna identifikovaného threadId. Vrátí seznam zpráv.
removeParticipant(CommunicationIdentifier, OperationOptions)	Odebere účastníka z vlákna identifikovaného identifikátorem threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Odešle zprávu chatu do vlákna identifikovaného identifikátorem threadId. Vrátí ID vytvořené zprávy.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Odešle potvrzení o přečtení do vlákna identifikovaného identifikátorem threadId.
sendTypingNotification(SendTypingNotificationOptions)	Odešle do vlákna napsané oznámení. Nepokouší se odeslat, pokud je čas od posledního oznámení menší než minimální interval zadávání.
updateMessage(string, UpdateMessageOptions)	Aktualizuje zprávu identifikovanou pomocí threadId a messageId.
updateProperties(UpdateChatThreadPropertiesOptions)	Aktualizuje vlastnosti vlákna.
updateTopic(string, UpdateTopicOptions)	Aktualizuje téma vlákna.

Podrobnosti konstruktoru

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parametry

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Podrobnosti vlastnosti

threadId

ID vlákna ChatThreadClient

threadId: string

Hodnota vlastnosti

string

Podrobnosti metody

addParticipants(AddParticipantsRequest, OperationOptions)

Přidá podrobnosti o účastnících chatu patřících do vlákna identifikovaného id vlákna.

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

Parametry

request

AddParticipantsRequest

Podrobnosti o vláknech pro přidání do seznamu vláken

options

OperationOptions

Možnosti operace.

Návraty

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Odstraní zprávu identifikovanou pomocí threadId a messageId.

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

Parametry

messageId

string

ID zprávy.

options

OperationOptions

Možnosti operace.

Návraty

Promise<void>

getMessage(string, OperationOptions)

Získá chatovou zprávu identifikovanou podle messageId. Vrátí konkrétní zprávu.

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

Parametry

messageId

string

ID zprávy.

options

OperationOptions

Možnosti operace.

Návraty

Promise<ChatMessage>

getProperties(OperationOptions)

Získá vlákno chatu. Vrátí vlákno chatu.

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

Parametry

options

OperationOptions

Možnosti operace.

Návraty

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

Získá seznam zpráv z vlákna identifikovaného threadId. Vrátí seznam zpráv.

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

Parametry

options

RestListMessagesOptions

Získejte možnosti zpráv.

Návraty

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

Získá účastníky vlákna identifikované threadId. Vrátí seznamy účastníků.

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

Parametry

options

RestListParticipantsOptions

Možnosti operace.

Návraty

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

Získá seznam potvrzení o přečtení z vlákna identifikovaného threadId. Vrátí seznam zpráv.

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

Parametry

options

RestListReadReceiptsOptions

Získejte možnosti zpráv.

Návraty

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Odebere účastníka z vlákna identifikovaného identifikátorem threadId.

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

Parametry

participant

CommunicationIdentifier

Účastník vlákna, který se má odebrat ze seznamu vláken

options

OperationOptions

Možnosti operace.

Návraty

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Odešle zprávu chatu do vlákna identifikovaného identifikátorem threadId. Vrátí ID vytvořené zprávy.

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

Parametry

request

SendMessageRequest

Žádost o odeslání zprávy

options

SendMessageOptions

Možnosti operace.

Návraty

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Odešle potvrzení o přečtení do vlákna identifikovaného identifikátorem threadId.

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

Parametry

request

SendReadReceiptRequest

Žádost o odeslání potvrzení o přečtení

options

OperationOptions

Možnosti operace.

Návraty

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Odešle do vlákna napsané oznámení. Nepokouší se odeslat, pokud je čas od posledního oznámení menší než minimální interval zadávání.

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

Parametry

options

SendTypingNotificationOptions

Možnosti operace

Návraty

Promise<boolean>

Hodnota True, pokud se může odeslat oznámení o psaní zprávy, jinak nepravda.

updateMessage(string, UpdateMessageOptions)

Aktualizuje zprávu identifikovanou pomocí threadId a messageId.

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

Parametry

messageId

string

ID zprávy.

options

UpdateMessageOptions

Možnosti operace.

Návraty

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

Aktualizuje vlastnosti vlákna.

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

Parametry

options

UpdateChatThreadPropertiesOptions

Možnosti operace.

Návraty

Promise<void>

updateTopic(string, UpdateTopicOptions)

Aktualizuje téma vlákna.

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

Parametry

topic

string

Téma je potřeba aktualizovat.

options

UpdateTopicOptions

Možnosti operace.

Návraty

Promise<void>