PollerLike interface

Paket:

@azure/keyvault-certificates

Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amacıyla bir poller'in soyut gösterimi.

Yöntemler

cancelOperation({ abortSignal?: AbortSignalLike })	Temel alınan işlemi iptal etmeye çalışır.
getOperationState()	İşlemin durumunu döndürür. PollerLike'de tanımlanan TState, Poller uygulamasında tanımlanan TState'in bir alt kümesi olabilir.
getResult()	Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımsız veya tamamlanmamış bir biçimini döndürebilir.
isDone()	Poller yoklamayı bitirdiyse true değerini döndürür.
isStopped()	Poller durdurulursa true döndürür.
onProgress((state: TState) => void)	Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir. Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür.
poll({ abortSignal?: AbortSignalLike })	Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu poller işleminin güncelleştirme yöntemini çağırarak yapar.
pollUntilDone({ abortSignal?: AbortSignalLike })	Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür.
stopPolling()	Poller'i durdurur. Bundan sonra el ile veya otomatik istek gönderilemiyor.
toString()	İşlemin toString yöntemini çağırarak poller işleminin serileştirilmiş bir sürümünü döndürür.

Yöntem Ayrıntıları

cancelOperation({ abortSignal?: AbortSignalLike })

Uyarı

Bu API artık kullanım dışıdır.

cancelOperation has been deprecated because it was not implemented.

Temel alınan işlemi iptal etmeye çalışır.

function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>

Parametreler

options

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<void>

getOperationState()

İşlemin durumunu döndürür. PollerLike'de tanımlanan TState, Poller uygulamasında tanımlanan TState'in bir alt kümesi olabilir.

function getOperationState(): TState

Döndürülenler

TState

getResult()

Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımsız veya tamamlanmamış bir biçimini döndürebilir.

function getResult(): undefined | TResult

Döndürülenler

undefined | TResult

isDone()

Poller yoklamayı bitirdiyse true değerini döndürür.

function isDone(): boolean

Döndürülenler

boolean

isStopped()

Poller durdurulursa true döndürür.

function isStopped(): boolean

Döndürülenler

boolean

onProgress((state: TState) => void)

Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir.

Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür.

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

Parametreler

callback

(state: TState) => void

Döndürülenler

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu poller işleminin güncelleştirme yöntemini çağırarak yapar.

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

Parametreler

options

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür.

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

Parametreler

pollOptions

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<TResult>

stopPolling()

Poller'i durdurur. Bundan sonra el ile veya otomatik istek gönderilemiyor.

function stopPolling()

toString()

İşlemin toString yöntemini çağırarak poller işleminin serileştirilmiş bir sürümünü döndürür.

function toString(): string

Döndürülenler

string