SimplePollerLike interface

Pacchetto:

@azure-rest/maps-route

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

Metodi

getOperationState()	Restituisce lo stato dell'operazione.
getResult()	Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma indefinita o incompleta del valore TResult finale a seconda dell'implementazione.
isDone()	Restituisce true se il poller ha terminato il polling.
isStopped()	Restituisce true se il poller viene arrestato.
onProgress((state: TState) => void)	Richiama il callback fornito dopo il completamento di ogni polling, inviando lo stato corrente dell'operazione del poller. Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti nella funzione di callback specificata.
poll({ abortSignal?: AbortSignalLike })	Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. A tale scopo, chiamare il metodo update dell'operazione di Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Restituisce una promessa che verrà risolta al termine dell'operazione sottostante.
serialize()	Restituisce una promessa che può essere utilizzata per la versione serializzata dell'operazione del poller richiamando il metodo serialize dell'operazione.
stopPolling()	Impedisce al poller di continuare a eseguire il polling. Si noti che interromperà solo il polling sul lato client
submitted()	Attendere che il poller venga inviato.
toString()	Restituisce una rappresentazione di stringa dell'operazione del poller. Simile a serializzare ma restituisce una stringa.

Dettagli metodo

getOperationState()

Restituisce lo stato dell'operazione.

function getOperationState(): TState

Restituisce

TState

getResult()

Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma indefinita o incompleta del valore TResult finale a seconda dell'implementazione.

function getResult(): undefined | TResult

Restituisce

undefined | TResult

isDone()

Restituisce true se il poller ha terminato il polling.

function isDone(): boolean

Restituisce

boolean

isStopped()

Avviso

Questa API è ora deprecata.

Use abortSignal status to track this instead.

Restituisce true se il poller viene arrestato.

function isStopped(): boolean

Restituisce

boolean

onProgress((state: TState) => void)

Richiama il callback fornito dopo il completamento di ogni polling, inviando lo stato corrente dell'operazione del poller.

Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti nella funzione di callback specificata.

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

Parametri

callback

(state: TState) => void

Restituisce

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. A tale scopo, chiamare il metodo update dell'operazione di Poller.

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

Parametri

options

{ abortSignal?: AbortSignalLike }

Restituisce

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Restituisce una promessa che verrà risolta al termine dell'operazione sottostante.

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

Parametri

pollOptions

{ abortSignal?: AbortSignalLike }

Restituisce

Promise<TResult>

serialize()

Restituisce una promessa che può essere utilizzata per la versione serializzata dell'operazione del poller richiamando il metodo serialize dell'operazione.

function serialize(): Promise<string>

Restituisce

Promise<string>

stopPolling()

Avviso

Questa API è ora deprecata.

Use abortSignal to stop polling instead.

Impedisce al poller di continuare a eseguire il polling. Si noti che interromperà solo il polling sul lato client

function stopPolling()

submitted()

Attendere che il poller venga inviato.

function submitted(): Promise<void>

Restituisce

Promise<void>

toString()

Avviso

Questa API è ora deprecata.

Use serialize() instead.

Restituisce una rappresentazione di stringa dell'operazione del poller. Simile a serializzare ma restituisce una stringa.

function toString(): string

Restituisce

string