PollerLike interface

Csomag:

@azure/keyvault-secrets

A poller absztrakt ábrázolása, amely csak a felhasználó által igényelt minimális API-t teszi elérhetővé.

Metódusok

cancelOperation({ abortSignal?: AbortSignalLike })	Megkísérli megszakítani a mögöttes műveletet.
getOperationState()	A művelet állapotát adja vissza. A PollerLikeben definiált TState a Poller-implementációban definiált TState részhalmaza lehet.
getResult()	A művelet eredményértékét adja vissza, függetlenül a lekérdezés állapotától. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja az implementációtól függően.
isDone()	Igaz értéket ad vissza, ha a lekérdezés befejeződött.
isStopped()	Igaz értéket ad vissza, ha a poller le van állítva.
onProgress((state: TState) => void)	Meghívja a megadott visszahívást az egyes lekérdezések befejezése után, és elküldi a lekérdezési művelet aktuális állapotát. Egy metódust ad vissza, amellyel a rendszer leállítja a frissítések fogadását az adott visszahívási függvényen.
poll({ abortSignal?: AbortSignalLike })	Egy olyan ígéretet ad vissza, amely egyetlen lekérdezési kérelem befejeződése után feloldható. Ezt a Poller-művelet frissítési metódusának meghívásával teszi meg.
pollUntilDone({ abortSignal?: AbortSignalLike })	Egy ígéretet ad vissza, amely a mögöttes művelet befejezése után feloldódik.
stopPolling()	Leállítja a pollert. Ezt követően nem lehet manuális vagy automatizált kéréseket küldeni.
toString()	A lekérdezési művelet szerializált verzióját adja vissza a művelet toString metódusának meghívásával.

Metódus adatai

cancelOperation({ abortSignal?: AbortSignalLike })

Figyelmeztetés

Ez az API már elavult.

cancelOperation has been deprecated because it was not implemented.

Megkísérli megszakítani a mögöttes műveletet.

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

Paraméterek

options

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<void>

getOperationState()

A művelet állapotát adja vissza. A PollerLikeben definiált TState a Poller-implementációban definiált TState részhalmaza lehet.

function getOperationState(): TState

Válaszok

TState

getResult()

A művelet eredményértékét adja vissza, függetlenül a lekérdezés állapotától. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja az implementációtól függően.

function getResult(): undefined | TResult

Válaszok

undefined | TResult

isDone()

Igaz értéket ad vissza, ha a lekérdezés befejeződött.

function isDone(): boolean

Válaszok

boolean

isStopped()

Igaz értéket ad vissza, ha a poller le van állítva.

function isStopped(): boolean

Válaszok

boolean

onProgress((state: TState) => void)

Meghívja a megadott visszahívást az egyes lekérdezések befejezése után, és elküldi a lekérdezési művelet aktuális állapotát.

Egy metódust ad vissza, amellyel a rendszer leállítja a frissítések fogadását az adott visszahívási függvényen.

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

Paraméterek

callback

(state: TState) => void

Válaszok

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Egy olyan ígéretet ad vissza, amely egyetlen lekérdezési kérelem befejeződése után feloldható. Ezt a Poller-művelet frissítési metódusának meghívásával teszi meg.

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

Paraméterek

options

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Egy ígéretet ad vissza, amely a mögöttes művelet befejezése után feloldódik.

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

Paraméterek

pollOptions

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<TResult>

stopPolling()

Leállítja a pollert. Ezt követően nem lehet manuális vagy automatizált kéréseket küldeni.

function stopPolling()

toString()

A lekérdezési művelet szerializált verzióját adja vissza a művelet toString metódusának meghívásával.

function toString(): string

Válaszok

string