AnalysisResultPoller interface
Poller do operacji analitycznej.
- Rozszerzenie
Właściwości
| operation |
Identyfikator operacji. |
Właściwości dziedziczone
| is |
Jest prawdą, jeśli ankieter skończył sondaże. |
| operation |
Stan operacji. Może być niezdefiniowany, jeśli polller nie został jeszcze złożony. |
| result | Wartość wynikowa operacji, niezależnie od stanu pollera. Może być niezdefiniowana lub niepełna forma ostatecznej wartości TResult, w zależności od implementacji. |
| [to |
Metody dziedziczone
| catch<TResult>((reason: any) => TResult | Promise |
Dołącza jedynie odrzucenie Obietnicy. |
| finally(() => void | null) | Dołącza wezwanie, które jest wywoływane po spełnieniu lub odrzuceniu Obietnicy. Wartość wyodrębniona nie może być zmieniona na podstawie wywołania. |
| on |
Wywołuje dostarczone callback po zakończeniu każdego odpytywania, wysyłając aktualny stan operacji pollera. Zwraca metodę, którą można użyć do zaprzestania otrzymywania aktualizacji danej funkcji callback. |
| poll({ abort |
Zwraca obietnicę, która zostanie rozwiązana, gdy zakończy się pojedyncze zgłoszenie. Robi to, wywołując metodę aktualizacji operacji Pollera. |
| poll |
Zwraca obietnicę, która zostanie rozwiązana po zakończeniu operacji bazowej. |
| serialize() | Zwraca obietnicę, którą można użyć w serializowanej wersji operacji Pollera poprzez wywołanie metody serializacji operacji. |
| submitted() | Zwraca obietnicę, którą można wykorzystać do sprawdzenia, czy list został wysłany. |
| then<TResult1, TResult2>((value: Analysis |
Dołącza odwołania do rozwiązania i/lub odrzucenia Obietnicy. |
Szczegóły właściwości
operationId
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Use operationState?.operationId instead.
Identyfikator operacji.
operationId?: string
Wartość właściwości
string
Szczegóły właściwości dziedziczonej
isDone
Jest prawdą, jeśli ankieter skończył sondaże.
isDone: boolean
Wartość właściwości
boolean
Dziedziczone od PollerLike.isDone
operationState
Stan operacji. Może być niezdefiniowany, jeśli polller nie został jeszcze złożony.
operationState: AnalysisOperationState | undefined
Wartość właściwości
AnalysisOperationState | undefined
Dziedziczone od PollerLike.operationState
result
Wartość wynikowa operacji, niezależnie od stanu pollera. Może być niezdefiniowana lub niepełna forma ostatecznej wartości TResult, w zależności od implementacji.
result: AnalysisResult | undefined
Wartość właściwości
AnalysisResult | undefined
Dziedziczone od PollerLike.result
[toStringTag]
[toStringTag]: string
Wartość właściwości
string
Odziedziczone od PollerLike. [doStringTag]
Szczegóły metody dziedziczonej
catch<TResult>((reason: any) => TResult | PromiseLike<TResult> | null)
Dołącza jedynie odrzucenie Obietnicy.
function catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult> | null): Promise<AnalysisResult | TResult>
Parametry
- onrejected
-
(reason: any) => TResult | PromiseLike<TResult> | null
Wezwanie do wykonania po odrzuceniu Obietnicy.
Zwraca
Promise<AnalysisResult | TResult>
Obietnica zakończenia rozmowy zwrotnej.
Dziedziczone od PollerLike.catch
finally(() => void | null)
Dołącza wezwanie, które jest wywoływane po spełnieniu lub odrzuceniu Obietnicy. Wartość wyodrębniona nie może być zmieniona na podstawie wywołania.
function finally(onfinally?: () => void | null): Promise<AnalysisResult>
Parametry
- onfinally
-
() => void | null
Wezwanie do wykonania po spełnieniu Obietnicy (spełnieniu lub odrzuceniu).
Zwraca
Promise<AnalysisResult>
Obietnica zakończenia rozmowy zwrotnej.
Dziedziczone od PollerLike.finally
onProgress((state: AnalysisOperationState) => void)
Wywołuje dostarczone callback po zakończeniu każdego odpytywania, wysyłając aktualny stan operacji pollera.
Zwraca metodę, którą można użyć do zaprzestania otrzymywania aktualizacji danej funkcji callback.
function onProgress(callback: (state: AnalysisOperationState) => void): CancelOnProgress
Parametry
- callback
-
(state: AnalysisOperationState) => void
Zwraca
Dziedziczone od PollerLike.onProgress
poll({ abortSignal?: AbortSignalLike })
Zwraca obietnicę, która zostanie rozwiązana, gdy zakończy się pojedyncze zgłoszenie. Robi to, wywołując metodę aktualizacji operacji Pollera.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<AnalysisOperationState>
Parametry
- options
-
{ abortSignal?: AbortSignalLike }
Zwraca
Promise<AnalysisOperationState>
Dziedziczone od PollerLike.poll
pollUntilDone({ abortSignal?: AbortSignalLike })
Zwraca obietnicę, która zostanie rozwiązana po zakończeniu operacji bazowej.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<AnalysisResult>
Parametry
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Zwraca
Promise<AnalysisResult>
Dziedziczone od PollerLike.pollUntilDone
serialize()
Zwraca obietnicę, którą można użyć w serializowanej wersji operacji Pollera poprzez wywołanie metody serializacji operacji.
function serialize(): Promise<string>
Zwraca
Promise<string>
Dziedziczone od PollerLike.serializuj
submitted()
Zwraca obietnicę, którą można wykorzystać do sprawdzenia, czy list został wysłany.
function submitted(): Promise<void>
Zwraca
Promise<void>
Dziedziczone od PollerLike.submit
then<TResult1, TResult2>((value: AnalysisResult) => TResult1 | PromiseLike<TResult1> | null, (reason: any) => TResult2 | PromiseLike<TResult2> | null)
Dołącza odwołania do rozwiązania i/lub odrzucenia Obietnicy.
function then<TResult1, TResult2>(onfulfilled?: (value: AnalysisResult) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): Promise<TResult1 | TResult2>
Parametry
- onfulfilled
-
(value: AnalysisResult) => TResult1 | PromiseLike<TResult1> | null
Wezwanie do wykonania po zakończeniu Obietnicy.
- onrejected
-
(reason: any) => TResult2 | PromiseLike<TResult2> | null
Wezwanie do wykonania po odrzuceniu Obietnicy.
Zwraca
Promise<TResult1 | TResult2>
Obietnica zakończenia każdego odwołania, które zostanie wykonane.
Dziedziczone od PollerLike.then