PollerLike interface

Paket:

@azure/ai-language-text

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

Extends

@azure/core-lro.SimplePollerLike<TState, TResult>

Özellikler

sendCancellationRequest

bir iptal isteği gönderir.

Devralınan Yöntemler

getOperationState()	İşlemin durumunu döndürür.
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ımlanmamış veya tamamlanmamış bir biçimini döndürebilir.
isDone()	Poller yoklamayı bitirdiyse true 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'ın 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önderemezsiniz.
toString()	İşlemin toString yöntemini çağırarak poller işleminin serileştirilmiş bir sürümünü döndürür.

Özellik Ayrıntıları

sendCancellationRequest

bir iptal isteği gönderir.

sendCancellationRequest: () => Promise<void>

Özellik Değeri

() => Promise<void>

Devralınan Yöntemin Ayrıntıları

getOperationState()

İşlemin durumunu döndürür.

function getOperationState(): TState

Döndürülenler

TState

SimplePollerLike.getOperationState Devralındı

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ımlanmamış veya tamamlanmamış bir biçimini döndürebilir.

function getResult(): undefined | TResult

Döndürülenler

undefined | TResult

SimplePollerLike.getResult Devralındı

isDone()

Poller yoklamayı bitirdiyse true döndürür.

function isDone(): boolean

Döndürülenler

boolean

SimplePollerLike.isDone Devralındı

isStopped()

Poller durdurulursa true döndürür.

function isStopped(): boolean

Döndürülenler

boolean

SimplePollerLike.isStopped Devralındı

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

SimplePollerLike.onProgress Devralındı

poll({ abortSignal?: AbortSignalLike })

Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu, Poller'ın 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>

SimplePollerLike.poll Devralındı

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>

SimplePollerLike.pollUntilDone'dan Devralınan

stopPolling()

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

function stopPolling()

SimplePollerLike.stopPolling Devralındı

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

SimplePollerLike.toString Devralındı