CreateChatThreadOptions interface

Pakket:

@azure/communication-chat

Opties voor het maken van een chatgesprek.

Uitbreiding

OperationOptions

Eigenschappen

idempotencyToken	Indien opgegeven, stuurt de client aan dat de aanvraag herhaalbaar is; dat wil gezegd dat de client de aanvraag meerdere keren kan indienen met dezelfde Idempotency-Token en een geschikt antwoord kan krijgen zonder dat de server de aanvraag meerdere keren uitvoert. De waarde van de Idempotency-Token is een ondoorzichtige tekenreeks die een door de client gegenereerde, wereldwijd unieke id voor de aanvraag vertegenwoordigt. Het wordt aanbevolen versie 4 (willekeurige) UUID's te gebruiken.
metadata	metagegevens
participants	Deelnemers die moeten worden toegevoegd aan de chat-thread.
retentionPolicy	Bewaarbeleid voor gegevens voor automatisch verwijderen.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

idempotencyToken

Indien opgegeven, stuurt de client aan dat de aanvraag herhaalbaar is; dat wil gezegd dat de client de aanvraag meerdere keren kan indienen met dezelfde Idempotency-Token en een geschikt antwoord kan krijgen zonder dat de server de aanvraag meerdere keren uitvoert. De waarde van de Idempotency-Token is een ondoorzichtige tekenreeks die een door de client gegenereerde, wereldwijd unieke id voor de aanvraag vertegenwoordigt. Het wordt aanbevolen versie 4 (willekeurige) UUID's te gebruiken.

idempotencyToken?: string

Waarde van eigenschap

string

metadata

metagegevens

metadata?: Record<string, string>

Waarde van eigenschap

Record<string, string>

participants

Deelnemers die moeten worden toegevoegd aan de chat-thread.

participants?: ChatParticipant[]

Waarde van eigenschap

ChatParticipant[]

retentionPolicy

Bewaarbeleid voor gegevens voor automatisch verwijderen.

retentionPolicy?: ChatRetentionPolicy

Waarde van eigenschap

ChatRetentionPolicy

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions