CreateChatThreadOptions interface

Pacote:

@azure/communication-chat

Opções para criar um tópico de chat.

Extends

OperationOptions

Propriedades

idempotencyToken	Se especificado, o cliente direciona que a solicitação é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com a mesma Idempotency-Token e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor do Idempotency-Token é uma cadeia de caracteres opaca que representa um identificador gerado pelo cliente, globalmente exclusivo para todos os tempos, para a solicitação. Recomenda-se o uso da versão 4 (aleatória) UUIDs.
metadata	metadados
participants	Participantes a serem adicionados ao tópico de chat.
retentionPolicy	Política de retenção de dados para exclusão automática.

Propriedades Herdadas

abortSignal	O sinal que pode ser usado para abortar solicitações.
onResponse	Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions	Opções para substituir o comportamento de serialização/desserialização.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

idempotencyToken

Se especificado, o cliente direciona que a solicitação é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com a mesma Idempotency-Token e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor do Idempotency-Token é uma cadeia de caracteres opaca que representa um identificador gerado pelo cliente, globalmente exclusivo para todos os tempos, para a solicitação. Recomenda-se o uso da versão 4 (aleatória) UUIDs.

idempotencyToken?: string

Valor de Propriedade

string

metadata

metadados

metadata?: Record<string, string>

Valor de Propriedade

Record<string, string>

participants

Participantes a serem adicionados ao tópico de chat.

participants?: ChatParticipant[]

Valor de Propriedade

ChatParticipant[]

retentionPolicy

Política de retenção de dados para exclusão automática.

retentionPolicy?: ChatRetentionPolicy

Valor de Propriedade

ChatRetentionPolicy

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/desserialização.

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

herdado de OperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions