CreateChatThreadOptions interface

パッケージ:

@azure/communication-chat

チャット スレッドを作成するためのオプション。

Extends

OperationOptions

プロパティ

idempotencyToken	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じIdempotency-Tokenで要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Idempotency-Tokenの値は、クライアントによって生成され、要求の識別子を常にグローバルに一意に表す不透明な文字列です。 バージョン 4 (ランダム) UUID を使用することをお勧めします。
participants	チャット スレッドに追加する参加者。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

idempotencyToken

指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じIdempotency-Tokenで要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Idempotency-Tokenの値は、クライアントによって生成され、要求の識別子を常にグローバルに一意に表す不透明な文字列です。 バージョン 4 (ランダム) UUID を使用することをお勧めします。

idempotencyToken?: string

プロパティ値

string

participants

チャット スレッドに追加する参加者。

participants?: ChatParticipant[]

プロパティ値

ChatParticipant[]

継承されたプロパティの詳細

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