SimplePollerLike interface

Pakket:

@azure-rest/maps-route

Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen.

Methoden

getOperationState()	Retourneert de status van de bewerking.
getResult()	Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.
isDone()	Retourneert waar als de poller de poller heeft voltooid.
isStopped()	Retourneert waar als de poller is gestopt.
onProgress((state: TState) => void)	Roept de opgegeven callback aan nadat elke polling is voltooid, waardoor de huidige status van de bewerking van de poller wordt verzonden. Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen.
poll({ abortSignal?: AbortSignalLike })	Retourneert een belofte die wordt omgezet zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.
pollUntilDone({ abortSignal?: AbortSignalLike })	Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid.
serialize()	Retourneert een belofte die kan worden gebruikt voor geserialiseerde versie van de bewerking van de poller door de serialisatiemethode van de bewerking aan te roepen.
stopPolling()	Hiermee voorkomt u dat de poller doorgaat naar de peiling. Houd er rekening mee dat hiermee alleen de polling aan de clientzijde wordt gestopt
submitted()	Wacht totdat de poller is verzonden.
toString()	Retourneert een tekenreeksweergave van de bewerking van de poller. Vergelijkbaar met serialiseren, maar retourneert een tekenreeks.

Methodedetails

getOperationState()

Retourneert de status van de bewerking.

function getOperationState(): TState

Retouren

TState

getResult()

Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.

function getResult(): undefined | TResult

Retouren

undefined | TResult

isDone()

Retourneert waar als de poller de poller heeft voltooid.

function isDone(): boolean

Retouren

boolean

isStopped()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal status to track this instead.

Retourneert waar als de poller is gestopt.

function isStopped(): boolean

Retouren

boolean

onProgress((state: TState) => void)

Roept de opgegeven callback aan nadat elke polling is voltooid, waardoor de huidige status van de bewerking van de poller wordt verzonden.

Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen.

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

Parameters

callback

(state: TState) => void

Retouren

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Retourneert een belofte die wordt omgezet zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.

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

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid.

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

Parameters

pollOptions

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TResult>

serialize()

Retourneert een belofte die kan worden gebruikt voor geserialiseerde versie van de bewerking van de poller door de serialisatiemethode van de bewerking aan te roepen.

function serialize(): Promise<string>

Retouren

Promise<string>

stopPolling()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal to stop polling instead.

Hiermee voorkomt u dat de poller doorgaat naar de peiling. Houd er rekening mee dat hiermee alleen de polling aan de clientzijde wordt gestopt

function stopPolling()

submitted()

Wacht totdat de poller is verzonden.

function submitted(): Promise<void>

Retouren

Promise<void>

toString()

Waarschuwing

Deze API is nu afgeschaft.

Use serialize() instead.

Retourneert een tekenreeksweergave van de bewerking van de poller. Vergelijkbaar met serialiseren, maar retourneert een tekenreeks.

function toString(): string

Retouren

string