ChatThreadClient class

Pacchetto:

@azure/communication-chat

Client per eseguire operazioni di chat

Costruttori

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Proprietà

threadId

ID thread di ChatThreadClient

Metodi

addParticipants(AddParticipantsRequest, OperationOptions)	Aggiunge i dettagli dei partecipanti alla chat appartenenti al thread identificato da threadId.
deleteMessage(string, OperationOptions)	Elimina un messaggio identificato da threadId e messageId
getMessage(string, OperationOptions)	Ottiene un messaggio di chat identificato da messageId. Restituisce il messaggio specifico.
getProperties(OperationOptions)	Ottiene un thread di chat. Restituisce il thread di chat.
listMessages(RestListMessagesOptions)	Ottiene un elenco di messaggi da un thread identificato da threadId. Restituisce l'elenco dei messaggi.
listParticipants(RestListParticipantsOptions)	Ottiene i partecipanti del thread identificato da threadId. Restituisce gli elenchi dei partecipanti.
listReadReceipts(RestListReadReceiptsOptions)	Ottiene un elenco di ricevute di lettura da un thread identificato da threadId. Restituisce l'elenco dei messaggi.
removeParticipant(CommunicationIdentifier, OperationOptions)	Rimuove il partecipante dal thread identificato da threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Invia un messaggio di chat a un thread identificato da threadId. Restituisce l'ID del messaggio creato.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Invia una ricevuta di lettura al thread identificato da threadId.
sendTypingNotification(SendTypingNotificationOptions)	Invia una notifica di digitazione al thread. Non tenta di inviare se l'ora dall'ultima notifica è inferiore all'intervallo di digitazione minimo
updateMessage(string, UpdateMessageOptions)	Aggiorna un messaggio identificato da threadId e messageId
updateTopic(string, UpdateTopicOptions)	Aggiorna l'argomento di un thread.

Dettagli costruttore

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parametri

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Dettagli proprietà

threadId

ID thread di ChatThreadClient

threadId: string

Valore della proprietà

string

Dettagli metodo

addParticipants(AddParticipantsRequest, OperationOptions)

Aggiunge i dettagli dei partecipanti alla chat appartenenti al thread identificato da threadId.

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

Parametri

request

AddParticipantsRequest

Dettagli dei partecipanti ai thread da aggiungere nell'elenco dei thread

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Elimina un messaggio identificato da threadId e messageId

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

Parametri

messageId

string

ID del messaggio.

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<void>

getMessage(string, OperationOptions)

Ottiene un messaggio di chat identificato da messageId. Restituisce il messaggio specifico.

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

Parametri

messageId

string

ID del messaggio.

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<ChatMessage>

getProperties(OperationOptions)

Ottiene un thread di chat. Restituisce il thread di chat.

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

Parametri

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Ottiene un elenco di messaggi da un thread identificato da threadId. Restituisce l'elenco dei messaggi.

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

Parametri

options

RestListMessagesOptions

Opzioni Recupera messaggi.

Restituisce

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Ottiene i partecipanti del thread identificato da threadId. Restituisce gli elenchi dei partecipanti.

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

Parametri

options

RestListParticipantsOptions

Opzioni dell'operazione.

Restituisce

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Ottiene un elenco di ricevute di lettura da un thread identificato da threadId. Restituisce l'elenco dei messaggi.

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

Parametri

options

RestListReadReceiptsOptions

Opzioni Recupera messaggi.

Restituisce

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Rimuove il partecipante dal thread identificato da threadId.

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

Parametri

participant

CommunicationIdentifier

Partecipante thread da rimuovere dall'elenco di thread

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Invia un messaggio di chat a un thread identificato da threadId. Restituisce l'ID del messaggio creato.

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

Parametri

request

SendMessageRequest

Richiesta di invio di un messaggio.

options

SendMessageOptions

Opzioni dell'operazione.

Restituisce

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Invia una ricevuta di lettura al thread identificato da threadId.

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

Parametri

request

SendReadReceiptRequest

Richiesta di invio di una ricevuta di lettura

options

OperationOptions

Opzioni dell'operazione.

Restituisce

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Invia una notifica di digitazione al thread. Non tenta di inviare se l'ora dall'ultima notifica è inferiore all'intervallo di digitazione minimo

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

Parametri

options

SendTypingNotificationOptions

Opzioni dell'operazione

Restituisce

Promise<boolean>

True se è possibile inviare la notifica del messaggio di digitazione; in caso contrario, false.

updateMessage(string, UpdateMessageOptions)

Aggiorna un messaggio identificato da threadId e messageId

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

Parametri

messageId

string

ID del messaggio.

options

UpdateMessageOptions

Opzioni dell'operazione.

Restituisce

Promise<void>

updateTopic(string, UpdateTopicOptions)

Aggiorna l'argomento di un thread.

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

Parametri

topic

string

L'argomento deve essere aggiornato a .

options

UpdateTopicOptions

Opzioni dell'operazione.

Restituisce

Promise<void>