Freigeben über

SimplePollerLike interface

  • Referenz
Paket:
@azure/core-lro

Eine einfache Poller-Schnittstelle.

Methoden

getOperationState()

Gibt den Status des Vorgangs zurück.
getResult()

Gibt den Ergebniswert des Vorgangs zurück, unabhängig vom Zustand des Pollers. Je nach Implementierung kann eine undefinierte oder unvollständige Form des endgültigen TResult-Werts zurückgegeben werden.
isDone()

Gibt true zurück, wenn der Abrufer die Abfrage abgeschlossen hat.
isStopped()

Gibt true zurück, wenn der Poller beendet wird.
onProgress((state: TState) => void)

Ruft den bereitgestellten Rückruf auf, nachdem die einzelnen Abrufe abgeschlossen sind, und sendet den aktuellen Zustand des Abrufvorgangs.

Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden.
poll({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abrufanforderung abgeschlossen ist. Dazu wird die Updatemethode des Pollers-Vorgangs aufgerufen.
pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.
stopPolling()

Beendet den Poller. Danach können keine manuellen oder automatisierten Anforderungen mehr gesendet werden.
toString()

Gibt eine serialisierte Version des Abrufvorgangs zurück, indem die toString-Methode des Vorgangs aufgerufen wird.

Details zur Methode

getOperationState()

Gibt den Status des Vorgangs zurück.

function getOperationState(): TState

Gibt zurück

TState

getResult()

Gibt den Ergebniswert des Vorgangs zurück, unabhängig vom Zustand des Pollers. Je nach Implementierung kann eine undefinierte oder unvollständige Form des endgültigen TResult-Werts zurückgegeben werden.

function getResult(): undefined | TResult

Gibt zurück

undefined | TResult

isDone()

Gibt true zurück, wenn der Abrufer die Abfrage abgeschlossen hat.

function isDone(): boolean

Gibt zurück

boolean

isStopped()

Gibt true zurück, wenn der Poller beendet wird.

function isStopped(): boolean

Gibt zurück

boolean

onProgress((state: TState) => void)

Ruft den bereitgestellten Rückruf auf, nachdem die einzelnen Abrufe abgeschlossen sind, und sendet den aktuellen Zustand des Abrufvorgangs.

Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden.

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

Parameter

callback

(state: TState) => void

Gibt zurück

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abrufanforderung abgeschlossen ist. Dazu wird die Updatemethode des Pollers-Vorgangs aufgerufen.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<TResult>

stopPolling()

Beendet den Poller. Danach können keine manuellen oder automatisierten Anforderungen mehr gesendet werden.

function stopPolling()

toString()

Gibt eine serialisierte Version des Abrufvorgangs zurück, indem die toString-Methode des Vorgangs aufgerufen wird.

function toString(): string

Gibt zurück

string