@azure/core-lro package
Rozhraní
CreateHttpPollerOptions |
Možnosti pro |
OperationConfig |
Konfigurace pro dotazování operace a kontrolu, jestli byla ukončena. |
OperationResponse |
Typ odpovědi LRO. |
OperationState |
Zatímco poller funguje jako místní řídicí mechanismus ke spuštění aktivace a čekání na dlouho běžící operaci, OperationState dokumentuje stav vzdálené dlouhotrvající operace. Aktualizuje se po každém hlasování. |
PollerLike |
A poller for an operation. |
RawRequest |
Jednoduchý typ nezpracovaného požadavku. |
RawResponse |
Jednoduchý typ nezpracované odpovědi. |
RunningOperation |
Popis dlouhotrvající operace |
Aliasy typu
CancelOnProgress |
CancelOnProgress se používá jako návratová hodnota metody OnProgress v Poller. Když uživatel vyvolá onProgress, musí předat funkci, která se bude volat jako zpětné volání s novými daty přijatými při každé aktualizaci operace dotazování. onProgress vrátí funkci, která zabrání jakékoli další aktualizaci, aby se dostala k původnímu zpětnému volání. |
OperationStatus |
Sada možných stavů, ve které může být operace v libovolném okamžiku. |
ResourceLocationConfig |
Potenciální umístění výsledku LRO, pokud je určeno rozšířením LRO ve swaggeru. |
RestorableOperationState |
Typ obnovitelné dlouhotrvající operace. |
Funkce
create |
Vytvoří poller, který lze použít k dotazování dlouhotrvající operace. |
deserialize |
Deserializuje stav |
Podrobnosti funkce
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Vytvoří poller, který lze použít k dotazování dlouhotrvající operace.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>
Parametry
- lro
-
RunningOperation<unknown>
Popis dlouhotrvající operace
- options
-
CreateHttpPollerOptions<TResult, TState>
možnosti konfigurace polleru
Návraty
PollerLike<TState, TResult>
inicializovaný poller
deserializeState<TResult, TState>(string)
Deserializuje stav
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>
Parametry
- serializedState
-
string
Návraty
RestorableOperationState<TResult, TState>