PollerLike interface

パッケージ:

@azure/keyvault-keys

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

メソッド

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

メソッドの詳細

cancelOperation({ abortSignal?: AbortSignalLike })

警告

この API は非推奨になりました。

cancelOperation has been deprecated because it was not implemented.

基になる操作を取り消そうとします。

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

パラメーター

options

{ abortSignal?: AbortSignalLike }

戻り値

Promise<void>

getOperationState()

操作の状態を返します。 PollerLike で定義されている TState は、Poller 実装で定義されている TState のサブセットにすることができます。

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 の操作の update メソッドを呼び出すことによって行われます。

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()

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

function toString(): string

戻り値

string