PollerLike interface

パッケージ:

@azure/ai-language-text

ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。

Extends

@azure/core-lro.SimplePollerLike<TState, TResult>

プロパティ

sendCancellationRequest

はキャンセル要求を送信します。

継承されたメソッド

getOperationState()	操作の状態を返します。
getResult()	ポーリングの状態に関係なく、操作の結果値を返します。 実装によっては、未定義または不完全な形式の最終的な TResult 値を返すことができます。
isDone()	ポーリングが完了した場合は true を返します。
isStopped()	ポーリングが停止している場合は true を返します。
onProgress((state: TState) => void)	ポーリングの完了後に指定されたコールバックを呼び出し、ポーリング者の操作の現在の状態を送信します。 指定されたコールバック関数の更新プログラムの受信を停止するために使用できるメソッドを返します。
poll({ abortSignal?: AbortSignalLike })	1 回のポーリング要求が完了すると解決される Promise を返します。 これは、Poller の操作の更新メソッドを呼び出すことによって行われます。
pollUntilDone({ abortSignal?: AbortSignalLike })	基になる操作が完了すると解決される Promise を返します。
stopPolling()	ポーリングを停止します。 この後は、手動または自動の要求を送信できません。
toString()	操作の toString メソッドを呼び出して、ポーリング者の操作のシリアル化されたバージョンを返します。

プロパティの詳細

sendCancellationRequest

はキャンセル要求を送信します。

sendCancellationRequest: () => Promise<void>

プロパティ値

() => Promise<void>

継承済みメソッドの詳細

getOperationState()

操作の状態を返します。

function getOperationState(): TState

戻り値

TState

simplePollerLike.getOperationState から継承

getResult()

ポーリングの状態に関係なく、操作の結果値を返します。 実装によっては、未定義または不完全な形式の最終的な TResult 値を返すことができます。

function getResult(): undefined | TResult

戻り値

undefined | TResult

SimplePollerLike.getResult から継承された

isDone()

ポーリングが完了した場合は true を返します。

function isDone(): boolean

戻り値

boolean

SimplePollerLike.isDone から継承された

isStopped()

ポーリングが停止している場合は true を返します。

function isStopped(): boolean

戻り値

boolean

simplePollerLike.isStopped から継承

onProgress((state: TState) => void)

ポーリングの完了後に指定されたコールバックを呼び出し、ポーリング者の操作の現在の状態を送信します。

指定されたコールバック関数の更新プログラムの受信を停止するために使用できるメソッドを返します。

function onProgress(callback: (state: TState) => void): CancelOnProgress

パラメーター

callback

(state: TState) => void

戻り値

CancelOnProgress

SimplePollerLike.onProgress から継承された

poll({ abortSignal?: AbortSignalLike })

1 回のポーリング要求が完了すると解決される Promise を返します。 これは、Poller の操作の更新メソッドを呼び出すことによって行われます。

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>

パラメーター

options

{ abortSignal?: AbortSignalLike }

戻り値

Promise<void>

simplePollerLike.poll から継承

pollUntilDone({ abortSignal?: AbortSignalLike })

基になる操作が完了すると解決される Promise を返します。

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

パラメーター

pollOptions

{ abortSignal?: AbortSignalLike }

戻り値

Promise<TResult>

SimplePollerLike.pollUntilDone から継承された

stopPolling()

ポーリングを停止します。 この後は、手動または自動の要求を送信できません。

function stopPolling()

SimplePollerLike.stopPolling から継承された

toString()

操作の toString メソッドを呼び出して、ポーリング者の操作のシリアル化されたバージョンを返します。

function toString(): string

戻り値

string

SimplePollerLike.toString から継承された