PollOperationState interface

Balíček:

@azure/keyvault-keys

PollOperationState obsahuje seznam nejmenší sady vlastností potřebných k definování jakékoli dlouho běžící operace poller.

Zatímco třída Poller funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání a potenciálně zrušení dlouhotrvající operace, PollOperationState dokumentuje stav vzdálené dlouhotrvající operace.

Měl by se aktualizovat alespoň při spuštění operace, po dokončení a při jejím zrušení. Implementace ale můžou mít libovolný další počet vlastností, které se dají aktualizovat z jiných důvodů.

Vlastnosti

error	Pokud operace zjistila nějakou chybu, bude existovat.
isCancelled	True, pokud byla operace zrušena.
isCompleted	True, pokud byla operace dokončena.
isStarted	Hodnota True, pokud byla operace spuštěna.
result	Bude existovat, pokud se operace uzavřela ve výsledku očekávaného typu.

Podrobnosti vlastnosti

error

Pokud operace zjistila nějakou chybu, bude existovat.

error?: Error

Hodnota vlastnosti

Error

isCancelled

True, pokud byla operace zrušena.

isCancelled?: boolean

Hodnota vlastnosti

boolean

isCompleted

True, pokud byla operace dokončena.

isCompleted?: boolean

Hodnota vlastnosti

boolean

isStarted

Hodnota True, pokud byla operace spuštěna.

isStarted?: boolean

Hodnota vlastnosti

boolean

result

Bude existovat, pokud se operace uzavřela ve výsledku očekávaného typu.

result?: TResult

Hodnota vlastnosti

TResult