CreateChatThreadOptions interface

Paket:

@azure/communication-chat

Optionen zum Erstellen eines Chatthreads.

Extends

OperationOptions

Eigenschaften

idempotencyToken	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., der Client kann die Anforderung mehrmals mit demselben Idempotency-Token stellen und eine entsprechende Antwort erhalten, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Idempotency-Token ist eine undurchsichtige Zeichenfolge, die eine vom Client generierte, global eindeutig für alle Zeit, Bezeichner für die Anforderung darstellt. Es wird empfohlen, UUIDs der Version 4 (zufällig) zu verwenden.
metadata	Metadaten
participants	Teilnehmer, die dem Chatthread hinzugefügt werden sollen.
retentionPolicy	Datenaufbewahrungsrichtlinie für die automatische Löschung.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
serializerOptions	Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

idempotencyToken

Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., der Client kann die Anforderung mehrmals mit demselben Idempotency-Token stellen und eine entsprechende Antwort erhalten, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Idempotency-Token ist eine undurchsichtige Zeichenfolge, die eine vom Client generierte, global eindeutig für alle Zeit, Bezeichner für die Anforderung darstellt. Es wird empfohlen, UUIDs der Version 4 (zufällig) zu verwenden.

idempotencyToken?: string

Eigenschaftswert

string

metadata

Metadaten

metadata?: Record<string, string>

Eigenschaftswert

Record<string, string>

participants

Teilnehmer, die dem Chatthread hinzugefügt werden sollen.

participants?: ChatParticipant[]

Eigenschaftswert

ChatParticipant[]

retentionPolicy

Datenaufbewahrungsrichtlinie für die automatische Löschung.

retentionPolicy?: ChatRetentionPolicy

Eigenschaftswert

ChatRetentionPolicy

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

von OperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Von OperationOptions.requestOptions geerbt

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

von OperationOptions.serializerOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von OperationOptions.tracingOptions geerbt