CreateChatThreadOptions interface

套件:

@azure/communication-chat

建立聊天對話的選項。

Extends

OperationOptions

屬性

idempotencyToken	如果指定，用戶端會指示要求可重複;也就是說，用戶端可以使用相同的 Idempotency-Token 多次提出要求，並取得適當的回應，而不需要伺服器多次執行要求。 Idempotency-Token 的值是不透明的字串，代表用戶端產生的全域唯一要求標識符。 建議使用第 4 版（隨機）UUID。
metadata	中繼資料
participants	要新增至聊天對話的參與者。
retentionPolicy	自動刪除的數據保留原則。

繼承的屬性

abortSignal	可用來中止要求的訊號。
onResponse	每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。
requestOptions	建立和傳送此作業之 HTTP 要求時所使用的選項。
serializerOptions	覆寫串行化/取消串行化行為的選項。
tracingOptions	啟用追蹤時所使用的選項。

屬性詳細資料

idempotencyToken

如果指定，用戶端會指示要求可重複;也就是說，用戶端可以使用相同的 Idempotency-Token 多次提出要求，並取得適當的回應，而不需要伺服器多次執行要求。 Idempotency-Token 的值是不透明的字串，代表用戶端產生的全域唯一要求標識符。 建議使用第 4 版（隨機）UUID。

idempotencyToken?: string

屬性值

string

metadata

中繼資料

metadata?: Record<string, string>

屬性值

Record<string, string>

participants

要新增至聊天對話的參與者。

participants?: ChatParticipant[]

屬性值

ChatParticipant[]

retentionPolicy

自動刪除的數據保留原則。

retentionPolicy?: ChatRetentionPolicy

屬性值

ChatRetentionPolicy

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

RawResponseCallback

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

OperationRequestOptions

繼承自 OperationOptions.requestOptions

serializerOptions

覆寫串行化/取消串行化行為的選項。

serializerOptions?: SerializerOptions

屬性值

SerializerOptions

繼承自 OperationOptions.serializerOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自 OperationOptions.tracingOptions