CreateChatThreadOptions interface

Balíček:

@azure/communication-chat

Možnosti vytvoření vlákna chatu

Extends

OperationOptions

Vlastnosti

idempotencyToken	Pokud je zadáno, klient směruje, že požadavek je opakovatelný; to znamená, že klient může požadavek provést několikrát se stejnými Idempotency-Token a získat odpovídající odpověď bez toho, aby server několikrát požadavek spouštěl. Hodnota Idempotency-Token je neprůzrný řetězec představující globálně vygenerovaný klientem, globálně jedinečný pro celou dobu identifikátor požadavku. Doporučuje se použít identifikátory UUID verze 4 (náhodné).
metadata	metadata
participants	Účastníci, kteří se mají přidat do vlákna chatu.
retentionPolicy	Zásady uchovávání dat pro automatické odstranění

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
onResponse	Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.
requestOptions	Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
serializerOptions	Možnosti přepsání serializace/de-serializace chování.
tracingOptions	Možnosti používané při povolení trasování

Podrobnosti vlastnosti

idempotencyToken

Pokud je zadáno, klient směruje, že požadavek je opakovatelný; to znamená, že klient může požadavek provést několikrát se stejnými Idempotency-Token a získat odpovídající odpověď bez toho, aby server několikrát požadavek spouštěl. Hodnota Idempotency-Token je neprůzrný řetězec představující globálně vygenerovaný klientem, globálně jedinečný pro celou dobu identifikátor požadavku. Doporučuje se použít identifikátory UUID verze 4 (náhodné).

idempotencyToken?: string

Hodnota vlastnosti

string

metadata

metadata

metadata?: Record<string, string>

Hodnota vlastnosti

Record<string, string>

participants

Účastníci, kteří se mají přidat do vlákna chatu.

participants?: ChatParticipant[]

Hodnota vlastnosti

ChatParticipant[]

retentionPolicy

Zásady uchovávání dat pro automatické odstranění

retentionPolicy?: ChatRetentionPolicy

Hodnota vlastnosti

ChatRetentionPolicy

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

zděděno z OperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

RawResponseCallback

zděděno z OperationOptions.onResponse

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

OperationRequestOptions

zděděno z OperationOptions.requestOptions

serializerOptions

Možnosti přepsání serializace/de-serializace chování.

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

zděděno z OperationOptions.serializerOptions

tracingOptions

Možnosti používané při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno z OperationOptions.tracingOptions