PollerOptions interface
Form Recognizer クライアントでの実行時間の長い操作 (ポーリング) のオプション。
- Extends
プロパティ
| on |
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。 |
| resume |
シリアル化されたポーリングャーの状態。 指定した場合、ポーリング操作は、新しい操作であるかのように開始されるのではなく、指定された状態から再開されます。 |
| update |
同じ操作に関連する後続の要求間の待機時間 (ミリ秒)。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
onProgress
ポーリングの状態が更新されたときに呼び出される、省略可能な初期進行状況ハンドラー。 このハンドラーは、ポーリングの状態が初期化された直後に 1 回呼び出されます。
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 から継承された