PollerOptions interface
Параметры длительных операций (опросщиков) в клиентах Распознавателя документов.
- Extends
Свойства
on |
Необязательный обработчик начального хода выполнения, который будет вызываться при обновлении состояния опрашителя. Этот обработчик будет вызываться сразу после инициализации состояния опрашителя. |
resume |
Сериализованное состояние опроса. При условии операция опроса будет возобновлена из заданного состояния вместо запуска, как если бы она была новой операцией. |
update |
Время ожидания (в миллисекундах) между последующими запросами, связанными с той же операцией. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
on |
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
serializer |
Параметры переопределения поведения сериализации и десериализации. |
tracing |
Параметры, используемые при включении трассировки. |
Сведения о свойстве
onProgress
Необязательный обработчик начального хода выполнения, который будет вызываться при обновлении состояния опрашителя. Этот обработчик будет вызываться сразу после инициализации состояния опрашителя.
onProgress?: (state: TState) => void
Значение свойства
(state: TState) => void
resumeFrom
Сериализованное состояние опроса. При условии операция опроса будет возобновлена из заданного состояния вместо запуска, как если бы она была новой операцией.
resumeFrom?: string
Значение свойства
string
updateIntervalInMs
Время ожидания (в миллисекундах) между последующими запросами, связанными с той же операцией.
updateIntervalInMs?: number
Значение свойства
number
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: AbortSignalLike
Значение свойства
наследуется от OperationOptions.abortSignal
onResponse
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
onResponse?: RawResponseCallback
Значение свойства
наследуется от OperationOptions.onResponse
requestOptions
Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
requestOptions?: OperationRequestOptions
Значение свойства
наследуется от OperationOptions.requestOptions
serializerOptions
Параметры переопределения поведения сериализации и десериализации.
serializerOptions?: SerializerOptions
Значение свойства
наследуется от OperationOptions.serializerOptions
tracingOptions
Параметры, используемые при включении трассировки.
tracingOptions?: OperationTracingOptions
Значение свойства
наследуется от OperationOptions.tracingOptions