SimplePollerLike interface

Balíček:

@azure/arm-elasticsan

Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.

Metody

getOperationState()	Vrátí stav operace.
getResult()	Vrací výslednou hodnotu operace bez ohledu na stav Pollera. Může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult v závislosti na implementaci.
isDone()	Vrací se pravda, pokud poller dokončil průzkum.
isStopped()	Vrací se true, pokud je poller zastaven.
onProgress((state: TState) => void)	Po dokončení každého dotazování vyvolá poskytnutý callback a odešle aktuální stav pollerova provozu. Vrací metodu, kterou lze použít k zastavení přijímání aktualizací dané funkce callbacku.
poll({ abortSignal?: AbortSignalLike })	Vrátí slib, který se vyřeší, jakmile dokončí jediný dotaz. Dělá to voláním metody aktualizace Pollerovy operace.
pollUntilDone({ abortSignal?: AbortSignalLike })	Vrátí slib, který se vyřeší po dokončení základní operace.
serialize()	Vrací příslib, který lze použít pro serializovanou verzi Pollerovy operace vyvoláním metody serializace této operace.
stopPolling()	Zastaví to průzkumníka v pokračování v průzkumu. Upozorňujeme, že tímto se zastaví pouze dotazování na straně klienta
submitted()	Počkejte na odeslání ankety.
toString()	Vrací řetězcovou reprezentaci Pollerovy operace. Podobně jako serializovat, ale vrací řetězec.

Podrobnosti metody

getOperationState()

Vrátí stav operace.

function getOperationState(): TState

Návraty

TState

getResult()

Vrací výslednou hodnotu operace bez ohledu na stav Pollera. Může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult v závislosti na implementaci.

function getResult(): undefined | TResult

Návraty

undefined | TResult

isDone()

Vrací se pravda, pokud poller dokončil průzkum.

function isDone(): boolean

Návraty

boolean

isStopped()

Upozornění

Toto rozhraní API je teď zastaralé.

Use abortSignal status to track this instead.

Vrací se true, pokud je poller zastaven.

function isStopped(): boolean

Návraty

boolean

onProgress((state: TState) => void)

Po dokončení každého dotazování vyvolá poskytnutý callback a odešle aktuální stav pollerova provozu.

Vrací metodu, kterou lze použít k zastavení přijímání aktualizací dané funkce callbacku.

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

Parametry

callback

(state: TState) => void

Návraty

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Vrátí slib, který se vyřeší, jakmile dokončí jediný dotaz. Dělá to voláním metody aktualizace Pollerovy operace.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Vrátí 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>

serialize()

Vrací příslib, který lze použít pro serializovanou verzi Pollerovy operace vyvoláním metody serializace této operace.

function serialize(): Promise<string>

Návraty

Promise<string>

stopPolling()

Upozornění

Toto rozhraní API je teď zastaralé.

Use abortSignal to stop polling instead.

Zastaví to průzkumníka v pokračování v průzkumu. Upozorňujeme, že tímto se zastaví pouze dotazování na straně klienta

function stopPolling()

submitted()

Počkejte na odeslání ankety.

function submitted(): Promise<void>

Návraty

Promise<void>

toString()

Upozornění

Toto rozhraní API je teď zastaralé.

Use serialize() instead.

Vrací řetězcovou reprezentaci Pollerovy operace. Podobně jako serializovat, ale vrací řetězec.

function toString(): string

Návraty

string