PollerLike interface

Balíček:

@azure/core-lro

Abstraktní reprezentace polleru, která má zpřístupnit jenom minimální rozhraní API, se kterým uživatel potřebuje pracovat.

Metody

cancelOperation({ abortSignal?: AbortSignalLike })	Pokusí se zrušit základní operaci.
getOperationState()	Vrátí stav operace. TState definované v PollerLike může být podmnožinou TState definované v Poller implementace.
getResult()	Vrátí výslednou hodnotu operace bez ohledu na stav polleru. V závislosti na implementaci může vrátit nedefinovaný nebo neúplný tvar konečné hodnoty TResult.
isDone()	Vrátí hodnotu true, pokud poller dokončil dotazování.
isStopped()	Vrátí hodnotu true, pokud je poller zastaven.
onProgress((state: TState) => void)	Vyvolá zadané zpětné volání po dokončení každého dotazování, odeslání aktuální stav operace pollera. Vrátí metodu, kterou lze použít k zastavení přijímání aktualizací u dané funkce zpětného volání.
poll({ abortSignal?: AbortSignalLike })	Vrátí příslib, který se vyřeší, jakmile se dokončí jeden dotazovací požadavek. Dělá to voláním metody aktualizace pollerovy operace.
pollUntilDone({ abortSignal?: AbortSignalLike })	Vrátí příslib, který se vyřeší po dokončení základní operace.
stopPolling()	Zastaví pollera. Poté se nedají posílat žádné ruční ani automatizované požadavky.
toString()	Vrátí serializovanou verzi pollerovy operace vyvoláním metody operace toString.

Podrobnosti metody

cancelOperation({ abortSignal?: AbortSignalLike })

Upozornění

Toto rozhraní API je teď zastaralé.

cancelOperation has been deprecated because it was not implemented.

Pokusí se zrušit základní operaci.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<void>

getOperationState()

Vrátí stav operace. TState definované v PollerLike může být podmnožinou TState definované v Poller implementace.

function getOperationState(): TState

Návraty

TState

getResult()

Vrátí výslednou hodnotu operace bez ohledu na stav polleru. V závislosti na implementaci může vrátit nedefinovaný nebo neúplný tvar konečné hodnoty TResult.

function getResult(): undefined | TResult

Návraty

undefined | TResult

isDone()

Vrátí hodnotu true, pokud poller dokončil dotazování.

function isDone(): boolean

Návraty

boolean

isStopped()

Vrátí hodnotu true, pokud je poller zastaven.

function isStopped(): boolean

Návraty

boolean

onProgress((state: TState) => void)

Vyvolá zadané zpětné volání po dokončení každého dotazování, odeslání aktuální stav operace pollera.

Vrátí metodu, kterou lze použít k zastavení přijímání aktualizací u dané funkce zpětného volání.

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

Parametry

callback

(state: TState) => void

Návraty

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší, jakmile se dokončí jeden dotazovací požadavek. Dělá to voláním metody aktualizace pollerovy operace.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší po dokončení základní operace.

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

Parametry

pollOptions

{ abortSignal?: AbortSignalLike }

Návraty

Promise<TResult>

stopPolling()

Zastaví pollera. Poté se nedají posílat žádné ruční ani automatizované požadavky.

function stopPolling()

toString()

Vrátí serializovanou verzi pollerovy operace vyvoláním metody operace toString.

function toString(): string

Návraty

string