ChatThreadClient class

Pakiet:

@azure/communication-chat

Klient wykonuje operacje czatu

Konstruktory

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Właściwości

threadId

Identyfikator wątku elementu ChatThreadClient

Metody

addParticipants(AddParticipantsRequest, OperationOptions)	Dodaje szczegóły uczestników czatu należących do wątku identyfikowanego przez threadId.
deleteMessage(string, OperationOptions)	Usuwa komunikat zidentyfikowany przez identyfikator threadId i messageId
getMessage(string, OperationOptions)	Pobiera wiadomość czatu zidentyfikowaną przez identyfikator messageId. Zwraca określony komunikat.
getProperties(OperationOptions)	Pobiera wątek czatu. Zwraca wątek czatu.
listMessages(RestListMessagesOptions)	Pobiera listę komunikatów z wątku zidentyfikowanego przez threadId. Zwraca listę komunikatów.
listParticipants(RestListParticipantsOptions)	Pobiera uczestników wątku zidentyfikowanego przez threadId. Zwraca listy uczestników.
listReadReceipts(RestListReadReceiptsOptions)	Pobiera listę potwierdzenia odczytu z wątku zidentyfikowanego przez threadId. Zwraca listę komunikatów.
removeParticipant(CommunicationIdentifier, OperationOptions)	Usuwa uczestnika z wątku identyfikowanego przez threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Wysyła wiadomość czatu do wątku zidentyfikowanego przez threadId. Zwraca identyfikator utworzonego komunikatu.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Wysyła potwierdzenie odczytu do wątku zidentyfikowanego przez threadId.
sendTypingNotification(SendTypingNotificationOptions)	Wysyła powiadomienie o wpisaniu do wątku. Nie próbuje wysłać, jeśli czas od ostatniego powiadomienia jest mniejszy niż minimalny interwał wpisywania
updateMessage(string, UpdateMessageOptions)	Aktualizacje komunikat zidentyfikowany przez identyfikator threadId i messageId
updateTopic(string, UpdateTopicOptions)	Aktualizacje temat wątku.

Szczegóły konstruktora

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parametry

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Szczegóły właściwości

threadId

Identyfikator wątku elementu ChatThreadClient

threadId: string

Wartość właściwości

string

Szczegóły metody

addParticipants(AddParticipantsRequest, OperationOptions)

Dodaje szczegóły uczestników czatu należących do wątku identyfikowanego przez threadId.

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

Parametry

request

AddParticipantsRequest

Szczegóły uczestników wątku, które mają zostać dodane do listy wątków

options

OperationOptions

Opcje operacji.

Zwraca

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Usuwa komunikat zidentyfikowany przez identyfikator threadId i messageId

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

Parametry

messageId

string

Identyfikator komunikatu wiadomości.

options

OperationOptions

Opcje operacji.

Zwraca

Promise<void>

getMessage(string, OperationOptions)

Pobiera wiadomość czatu zidentyfikowaną przez identyfikator messageId. Zwraca określony komunikat.

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

Parametry

messageId

string

Identyfikator komunikatu wiadomości.

options

OperationOptions

Opcje operacji.

Zwraca

Promise<ChatMessage>

getProperties(OperationOptions)

Pobiera wątek czatu. Zwraca wątek czatu.

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

Parametry

options

OperationOptions

Opcje operacji.

Zwraca

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Pobiera listę komunikatów z wątku zidentyfikowanego przez threadId. Zwraca listę komunikatów.

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

Parametry

options

RestListMessagesOptions

Pobierz opcje komunikatów.

Zwraca

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Pobiera uczestników wątku zidentyfikowanego przez threadId. Zwraca listy uczestników.

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

Parametry

options

RestListParticipantsOptions

Opcje operacji.

Zwraca

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Pobiera listę potwierdzenia odczytu z wątku zidentyfikowanego przez threadId. Zwraca listę komunikatów.

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

Parametry

options

RestListReadReceiptsOptions

Pobierz opcje komunikatów.

Zwraca

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Usuwa uczestnika z wątku identyfikowanego przez threadId.

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

Parametry

participant

CommunicationIdentifier

Uczestnik wątku do usunięcia z listy wątków

options

OperationOptions

Opcje operacji.

Zwraca

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Wysyła wiadomość czatu do wątku zidentyfikowanego przez threadId. Zwraca identyfikator utworzonego komunikatu.

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

Parametry

request

SendMessageRequest

Żądanie wysłania wiadomości.

options

SendMessageOptions

Opcje operacji.

Zwraca

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Wysyła potwierdzenie odczytu do wątku zidentyfikowanego przez threadId.

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

Parametry

request

SendReadReceiptRequest

Żądanie wysłania potwierdzenia odczytu

options

OperationOptions

Opcje operacji.

Zwraca

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Wysyła powiadomienie o wpisaniu do wątku. Nie próbuje wysłać, jeśli czas od ostatniego powiadomienia jest mniejszy niż minimalny interwał wpisywania

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

Parametry

options

SendTypingNotificationOptions

Opcje operacji

Zwraca

Promise<boolean>

Wartość True, jeśli można wysłać powiadomienie o wiadomości, w przeciwnym razie wartość false.

updateMessage(string, UpdateMessageOptions)

Aktualizacje komunikat zidentyfikowany przez identyfikator threadId i messageId

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

Parametry

messageId

string

Identyfikator komunikatu wiadomości.

options

UpdateMessageOptions

Opcje operacji.

Zwraca

Promise<void>

updateTopic(string, UpdateTopicOptions)

Aktualizacje temat wątku.

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

Parametry

topic

string

Temat musi zostać zaktualizowany do.

options

UpdateTopicOptions

Opcje operacji.

Zwraca

Promise<void>