ChatThreadClient class

Paket:

@azure/communication-chat

Der Client zum Ausführen von Chatvorgängen

Konstruktoren

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Eigenschaften

threadId

Thread-ID des ChatThreadClient

Methoden

addParticipants(AddParticipantsRequest, OperationOptions)	Fügt die Details der Chatteilnehmer hinzu, die zu dem durch threadId identifizierten Thread gehören.
deleteMessage(string, OperationOptions)	Löscht eine Nachricht, die durch threadId und messageId identifiziert wird.
getMessage(string, OperationOptions)	Ruft eine Chatnachricht ab, die durch messageId identifiziert wird. Gibt die spezifische Nachricht zurück.
getProperties(OperationOptions)	Ruft einen Chatthread ab. Gibt den Chatthread zurück.
listMessages(RestListMessagesOptions)	Ruft eine Liste der Nachrichten von einem Thread ab, der durch threadId identifiziert wird. Gibt die Liste der Nachrichten zurück.
listParticipants(RestListParticipantsOptions)	Ruft die Teilnehmer des Threads ab, die durch threadId identifiziert werden. Gibt die Listen der Teilnehmer zurück.
listReadReceipts(RestListReadReceiptsOptions)	Ruft eine Liste der Lesebestätigungen aus einem Thread ab, der durch threadId identifiziert wird. Gibt die Liste der Nachrichten zurück.
removeParticipant(CommunicationIdentifier, OperationOptions)	Entfernt den Teilnehmer aus dem Thread, der durch threadId identifiziert wird.
sendMessage(SendMessageRequest, SendMessageOptions)	Sendet eine Chatnachricht an einen Thread, der durch threadId identifiziert wird. Gibt die ID der erstellten Nachricht zurück.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Sendet eine Lesebestätigung an den Thread, der durch threadId identifiziert wird.
sendTypingNotification(SendTypingNotificationOptions)	Sendet eine Eingabebenachrichtigung an den Thread. Versucht nicht zu senden, wenn die Zeit seit der letzten Benachrichtigung kleiner als das minimale Eingabeintervall ist.
updateMessage(string, UpdateMessageOptions)	Aktualisierungen einer Nachricht, die durch threadId und messageId identifiziert wird
updateTopic(string, UpdateTopicOptions)	Aktualisierungen das Thema eines Threads.

Details zum Konstruktor

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parameter

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Details zur Eigenschaft

threadId

Thread-ID des ChatThreadClient

threadId: string

Eigenschaftswert

string

Details zur Methode

addParticipants(AddParticipantsRequest, OperationOptions)

Fügt die Details der Chatteilnehmer hinzu, die zu dem durch threadId identifizierten Thread gehören.

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

Parameter

request

AddParticipantsRequest

Details der Threadteilnehmer, die der Threadliste hinzugefügt werden sollen

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Löscht eine Nachricht, die durch threadId und messageId identifiziert wird.

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

Parameter

messageId

string

Die Nachrichten-ID der Nachricht.

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>

getMessage(string, OperationOptions)

Ruft eine Chatnachricht ab, die durch messageId identifiziert wird. Gibt die spezifische Nachricht zurück.

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

Parameter

messageId

string

Die Nachrichten-ID der Nachricht.

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<ChatMessage>

getProperties(OperationOptions)

Ruft einen Chatthread ab. Gibt den Chatthread zurück.

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

Parameter

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Ruft eine Liste der Nachrichten von einem Thread ab, der durch threadId identifiziert wird. Gibt die Liste der Nachrichten zurück.

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

Parameter

options

RestListMessagesOptions

Abrufen von Nachrichtenoptionen.

Gibt zurück

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Ruft die Teilnehmer des Threads ab, die durch threadId identifiziert werden. Gibt die Listen der Teilnehmer zurück.

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

Parameter

options

RestListParticipantsOptions

Vorgangsoptionen.

Gibt zurück

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Ruft eine Liste der Lesebestätigungen aus einem Thread ab, der durch threadId identifiziert wird. Gibt die Liste der Nachrichten zurück.

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

Parameter

options

RestListReadReceiptsOptions

Abrufen von Nachrichtenoptionen.

Gibt zurück

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Entfernt den Teilnehmer aus dem Thread, der durch threadId identifiziert wird.

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

Parameter

participant

CommunicationIdentifier

Threadteilnehmer, der aus der Threadliste entfernt werden soll

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Sendet eine Chatnachricht an einen Thread, der durch threadId identifiziert wird. Gibt die ID der erstellten Nachricht zurück.

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

Parameter

request

SendMessageRequest

Anforderung zum Senden einer Nachricht.

options

SendMessageOptions

Vorgangsoptionen.

Gibt zurück

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Sendet eine Lesebestätigung an den Thread, der durch threadId identifiziert wird.

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

Parameter

request

SendReadReceiptRequest

Anforderung zum Senden einer Lesebestätigung

options

OperationOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Sendet eine Eingabebenachrichtigung an den Thread. Versucht nicht zu senden, wenn die Zeit seit der letzten Benachrichtigung kleiner als das minimale Eingabeintervall ist.

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

Parameter

options

SendTypingNotificationOptions

Optionen für den Vorgang

Gibt zurück

Promise<boolean>

True, wenn die Eingabenachricht gesendet werden könnte, andernfalls false.

updateMessage(string, UpdateMessageOptions)

Aktualisierungen einer Nachricht, die durch threadId und messageId identifiziert wird

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

Parameter

messageId

string

Die Nachrichten-ID der Nachricht.

options

UpdateMessageOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>

updateTopic(string, UpdateTopicOptions)

Aktualisierungen das Thema eines Threads.

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

Parameter

topic

string

Das Thema muss in aktualisiert werden.

options

UpdateTopicOptions

Vorgangsoptionen.

Gibt zurück

Promise<void>