Dela via

SimplePollerLike interface

  • Referens
Paket:
@azure-rest/maps-route

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

Metoder

getOperationState()

Returnerar åtgärdens tillstånd.
getResult()

Returnerar åtgärdens resultatvärde, oavsett pollerarens tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.
isDone()

Returnerar sant om polleraren har slutfört avsökningen.
isStopped()

Returnerar sant om polleraren stoppas.
onProgress((state: TState) => void)

Anropar det angivna återanropet efter att varje avsökning har slutförts och skickar det aktuella tillståndet för pollerns åtgärd.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar för den angivna återanropsfunktionen.
poll({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som löser när en enskild avsökningsbegäran har slutförts. Det gör den genom att anropa uppdateringsmetoden för Poller-åtgärden.
pollUntilDone({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när den underliggande åtgärden har slutförts.
serialize()

Returnerar ett löfte som kan användas för serialiserad version av pollerns åtgärd genom att anropa åtgärdens serialiseringsmetod.
stopPolling()

Hindrar polleraren från att fortsätta att avsöka. Observera att detta endast stoppar avsökningen på klientsidan
submitted()

Vänta tills pollern har skickats.
toString()

Returnerar en strängrepresentation av pollerns åtgärd. Liknar serialisera men returnerar en sträng.

Metodinformation

getOperationState()

Returnerar åtgärdens tillstånd.

function getOperationState(): TState

Returer

TState

getResult()

Returnerar åtgärdens resultatvärde, oavsett pollerarens tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

function getResult(): undefined | TResult

Returer

undefined | TResult

isDone()

Returnerar sant om polleraren har slutfört avsökningen.

function isDone(): boolean

Returer

boolean

isStopped()

Varning

Det här API:et är nu inaktuellt.

Use abortSignal status to track this instead.

Returnerar sant om polleraren stoppas.

function isStopped(): boolean

Returer

boolean

onProgress((state: TState) => void)

Anropar det angivna återanropet efter att varje avsökning har slutförts och skickar det aktuella tillståndet för pollerns åtgärd.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar för den angivna återanropsfunktionen.

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

Parametrar

callback

(state: TState) => void

Returer

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som löser när en enskild avsökningsbegäran har slutförts. Det gör den genom att anropa uppdateringsmetoden för Poller-åtgärden.

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

Parametrar

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när den underliggande åtgärden har slutförts.

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

Parametrar

pollOptions

{ abortSignal?: AbortSignalLike }

Returer

Promise<TResult>

serialize()

Returnerar ett löfte som kan användas för serialiserad version av pollerns åtgärd genom att anropa åtgärdens serialiseringsmetod.

function serialize(): Promise<string>

Returer

Promise<string>

stopPolling()

Varning

Det här API:et är nu inaktuellt.

Use abortSignal to stop polling instead.

Hindrar polleraren från att fortsätta att avsöka. Observera att detta endast stoppar avsökningen på klientsidan

function stopPolling()

submitted()

Vänta tills pollern har skickats.

function submitted(): Promise<void>

Returer

Promise<void>

toString()

Varning

Det här API:et är nu inaktuellt.

Use serialize() instead.

Returnerar en strängrepresentation av pollerns åtgärd. Liknar serialisera men returnerar en sträng.

function toString(): string

Returer

string