AnalysisResultPoller interface
Un sondaggio per un'operazione di analisi.
- Extends
Proprietà
| operation |
ID operazione. |
Proprietà ereditate
| is |
È vero se il sondaggiatore ha finito di studiare. |
| operation |
Stato dell'operazione. Può essere indefinito se il sondatore non è ancora stato inviato. |
| result | Il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può essere indefinita o una forma incompleta del valore finale di TResult a seconda dell'implementazione. |
| [to |
Metodi ereditati
| catch<TResult>(null | (reason: any) => TResult | Promise |
Allega un richiamo solo per il rifiuto della Promessa. |
| finally(null | () => void) | Allega un callback che viene invocato quando la Promessa viene conclusa (mantenuta o rifiutata). Il valore risolto non può essere modificato dal callback. |
| on |
Invoca il callback fornito dopo ogni sondaggio, inviando lo stato attuale dell'operazione del poller. Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti sulla funzione di callback data. |
| poll({ abort |
Restituisce una promessa che si risolverà una volta terminata una singola richiesta di sondaggio. Lo fa chiamando il metodo di aggiornamento dell'operazione del Poller. |
| poll |
Restituisce una promessa che si risolverà una volta completata l'operazione sottostante. |
| serialize() | Restituisce una promessa che potrebbe essere utilizzata per la versione serializzata dell'operazione del poller invocando il metodo di serializzazione dell'operazione. |
| submitted() | Restituisce una promessa che potrebbe essere usata per verificare se il sondaggio è stato inviato. |
| then<TResult1, TResult2>(null | (value: Analysis |
Allega richiami per la risoluzione e/o il rifiuto della Promessa. |
Dettagli proprietà
operationId
Avviso
Questa API è ora deprecata.
Use operationState?.operationId instead.
ID operazione.
operationId?: string
Valore della proprietà
string
Dettagli proprietà ereditate
isDone
È vero se il sondaggiatore ha finito di studiare.
isDone: boolean
Valore della proprietà
boolean
Ereditato da PollerLike.isDone
operationState
Stato dell'operazione. Può essere indefinito se il sondatore non è ancora stato inviato.
operationState: undefined | AnalysisOperationState
Valore della proprietà
undefined | AnalysisOperationState
Ereditato da PollerLike.operationState
result
Il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può essere indefinita o una forma incompleta del valore finale di TResult a seconda dell'implementazione.
result: undefined | AnalysisResult
Valore della proprietà
undefined | AnalysisResult
Ereditato da PollerLike.result
[toStringTag]
[toStringTag]: string
Valore della proprietà
string
Ereditato da PollerLike.__@toStringTag@334
Dettagli dei metodi ereditati
catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)
Allega un richiamo solo per il rifiuto della Promessa.
function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<AnalysisResult | TResult>
Parametri
- onrejected
-
null | (reason: any) => TResult | PromiseLike<TResult>
Il richiamo all'esecuzione quando la Promessa viene rifiutata.
Valori restituiti
Promise<AnalysisResult | TResult>
Una promessa per il completamento del richiamo.
Ereditato da PollerLike.catch
finally(null | () => void)
Allega un callback che viene invocato quando la Promessa viene conclusa (mantenuta o rifiutata). Il valore risolto non può essere modificato dal callback.
function finally(onfinally?: null | () => void): Promise<AnalysisResult>
Parametri
- onfinally
-
null | () => void
Il richiamo all'esecuzione quando la Promessa viene saldata (mantenuta o rifiutata).
Valori restituiti
Promise<AnalysisResult>
Una promessa per il completamento del richiamo.
Ereditato da PollerLike.finally
onProgress((state: AnalysisOperationState) => void)
Invoca il callback fornito dopo ogni sondaggio, inviando lo stato attuale dell'operazione del poller.
Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti sulla funzione di callback data.
function onProgress(callback: (state: AnalysisOperationState) => void): CancelOnProgress
Parametri
- callback
-
(state: AnalysisOperationState) => void
Valori restituiti
Ereditato da PollerLike.onProgress
poll({ abortSignal?: AbortSignalLike })
Restituisce una promessa che si risolverà una volta terminata una singola richiesta di sondaggio. Lo fa chiamando il metodo di aggiornamento dell'operazione del Poller.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<AnalysisOperationState>
Parametri
- options
-
{ abortSignal?: AbortSignalLike }
Valori restituiti
Promise<AnalysisOperationState>
Ereditato da PollerLike.poll
pollUntilDone({ abortSignal?: AbortSignalLike })
Restituisce una promessa che si risolverà una volta completata l'operazione sottostante.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<AnalysisResult>
Parametri
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Valori restituiti
Promise<AnalysisResult>
Ereditato da PollerLike.pollUntilDone
serialize()
Restituisce una promessa che potrebbe essere utilizzata per la versione serializzata dell'operazione del poller invocando il metodo di serializzazione dell'operazione.
function serialize(): Promise<string>
Valori restituiti
Promise<string>
Ereditato da PollerLike.serialize
submitted()
Restituisce una promessa che potrebbe essere usata per verificare se il sondaggio è stato inviato.
function submitted(): Promise<void>
Valori restituiti
Promise<void>
Ereditato da PollerLike.submitted
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)
Allega richiami per la risoluzione e/o il rifiuto della Promessa.
function then<TResult1, TResult2>(onfulfilled?: null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
Parametri
- onfulfilled
-
null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>
Il richiamo all'esecuzione quando la Promessa sarà risolta.
- onrejected
-
null | (reason: any) => TResult2 | PromiseLike<TResult2>
Il richiamo all'esecuzione quando la Promessa viene rifiutata.
Valori restituiti
Promise<TResult1 | TResult2>
Una promessa per il completamento di qualunque callback venga eseguito.
Ereditato da PollerLike.then