PollerOptions interface
Opções para operações de execução prolongada (pollers) no Reconhecedor de Formulários clientes.
- Extends
Propriedades
on |
Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após a inicialização do estado do poller. |
resume |
Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada do estado especificado em vez de iniciada como se fosse uma nova operação. |
update |
A quantidade de tempo a aguardar (em milissegundos) entre os pedidos subsequentes relacionados com a mesma operação. |
Propriedades Herdadas
abort |
O sinal que pode ser utilizado para abortar pedidos. |
on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes. |
request |
Opções utilizadas ao criar e enviar pedidos HTTP para esta operação. |
serializer |
Opções para substituir o comportamento de serialização/des serialização. |
tracing |
Opções utilizadas quando o rastreio está ativado. |
Detalhes de Propriedade
onProgress
Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após a inicialização do estado do poller.
onProgress?: (state: TState) => void
Valor de Propriedade
(state: TState) => void
resumeFrom
Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada do estado especificado em vez de iniciada como se fosse uma nova operação.
resumeFrom?: string
Valor de Propriedade
string
updateIntervalInMs
A quantidade de tempo a aguardar (em milissegundos) entre os pedidos subsequentes relacionados com a mesma operação.
updateIntervalInMs?: number
Valor de Propriedade
number
Detalhes da Propriedade Herdada
abortSignal
O sinal que pode ser utilizado para abortar pedidos.
abortSignal?: AbortSignalLike
Valor de Propriedade
Herdado de OperationOptions.abortSignal
onResponse
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor de Propriedade
Herdado de OperationOptions.onResponse
requestOptions
Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.
requestOptions?: OperationRequestOptions
Valor de Propriedade
Herdado de OperationOptions.requestOptions
serializerOptions
Opções para substituir o comportamento de serialização/des serialização.
serializerOptions?: SerializerOptions
Valor de Propriedade
Herdado de OperationOptions.serializerOptions
tracingOptions
Opções utilizadas quando o rastreio está ativado.
tracingOptions?: OperationTracingOptions
Valor de Propriedade
Herdado de OperationOptions.tracingOptions