ReceiveEventsOptions interface
Opções de eventos de recebimento
- Extends
Propriedades herdadas
abort |
O sinal que pode ser usado para anular solicitações. |
max |
Contagem máxima de eventos a serem recebidos. O valor mínimo é 1, enquanto o valor máximo é 100 eventos. Se não for especificado, o valor padrão será 1. |
max |
Valor máximo do tempo de espera para a operação de recebimento em Segundos. É o tempo em segundos que o servidor aguarda aproximadamente a disponibilidade de um evento e responde à solicitação. Se um evento estiver disponível, o agente responderá imediatamente ao cliente. O valor mínimo é de 10 segundos, enquanto o valor máximo é de 120 segundos. Se não for especificado, o valor padrão será 60 segundos. |
on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
request |
Opções usadas ao criar e enviar solicitações HTTP para essa operação. |
tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLike
Valor da propriedade
Herdado deReceiveEventsOptionalParams.abortSignal
maxEvents
Contagem máxima de eventos a serem recebidos. O valor mínimo é 1, enquanto o valor máximo é 100 eventos. Se não for especificado, o valor padrão será 1.
maxEvents?: number
Valor da propriedade
number
Herdado deReceiveEventsOptionalParams.maxEvents
maxWaitTime
Valor máximo do tempo de espera para a operação de recebimento em Segundos. É o tempo em segundos que o servidor aguarda aproximadamente a disponibilidade de um evento e responde à solicitação. Se um evento estiver disponível, o agente responderá imediatamente ao cliente. O valor mínimo é de 10 segundos, enquanto o valor máximo é de 120 segundos. Se não for especificado, o valor padrão será 60 segundos.
maxWaitTime?: number
Valor da propriedade
number
Herdado deReceiveEventsOptionalParams.maxWaitTime
onResponse
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor da propriedade
Herdado deReceiveEventsOptionalParams.onResponse
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para essa operação.
requestOptions?: OperationRequestOptions
Valor da propriedade
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions