SimplePollerLike interface

Balíček:

@azure-rest/maps-route

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

Metody

getOperationState()	Vrátí stav operace.
getResult()	Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu 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á poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller. Vrátí metodu, která se dá použít k zastavení příjmu aktualizací dané funkce zpětného volání.
poll({ abortSignal?: AbortSignalLike })	Vrátí příslib, který se vyřeší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Vrátí příslib, který se vyřeší po dokončení základní operace.
serialize()	Vrátí příslib, který lze použít pro serializovanou verzi operace poller vyvoláním metody serializace operace.
stopPolling()	Zastaví poller pokračovat v hlasování. Upozorňujeme, že toto nastavení zastaví pouze dotazování na straně klienta.
submitted()	Počkejte, než se odešle poller.
toString()	Vrátí řetězcovou reprezentaci operace vrtule. Podobá se serializaci, ale vrací řetězec.

Podrobnosti metody

getOperationState()

Vrátí stav operace.

function getOperationState(): TState

Návraty

TState

getResult()

Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu 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()

Upozornění

Toto rozhraní API je teď zastaralé.

Use abortSignal status to track this instead.

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

function isStopped(): boolean

Návraty

boolean

onProgress((state: TState) => void)

Vyvolá poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller.

Vrátí metodu, která se dá použít k zastavení příjmu aktualizací 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ší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<TState>

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>

serialize()

Vrátí příslib, který lze použít pro serializovanou verzi operace poller vyvoláním metody serializace 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í poller pokračovat v hlasování. Upozorňujeme, že toto nastavení zastaví pouze dotazování na straně klienta.

function stopPolling()

submitted()

Počkejte, než se odešle poller.

function submitted(): Promise<void>

Návraty

Promise<void>

toString()

Upozornění

Toto rozhraní API je teď zastaralé.

Use serialize() instead.

Vrátí řetězcovou reprezentaci operace vrtule. Podobá se serializaci, ale vrací řetězec.

function toString(): string

Návraty

string