PollerLike interface

パッケージ:

@azure/keyvault-admin

実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。

メソッド

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

メソッドの詳細

getOperationState()

操作の状態を返します。

function getOperationState(): TState

戻り値

TState

getResult()

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

function getResult(): undefined | TResult

戻り値

undefined | TResult

isDone()

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

function isDone(): boolean

戻り値

boolean

isStopped()

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

function isStopped(): boolean

戻り値

boolean

onProgress((state: TState) => void)

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

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

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

パラメーター

callback

(state: TState) => void

戻り値

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

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

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

パラメーター

options

{ abortSignal?: AbortSignalLike }

戻り値

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

パラメーター

pollOptions

{ abortSignal?: AbortSignalLike }

戻り値

Promise<TResult>

stopPolling()

ポーリングを続行するポーリングを停止します。 これにより、クライアント側のポーリングのみが停止されることに注意してください

function stopPolling()

toString()

ポーリング者の操作の文字列形式を返します。 シリアル化に似ていますが、文字列を返します。

function toString(): string

戻り値

string