PollerLike interface

Paket:

@azure/ai-language-text

Representasi abstrak dari poller, dimaksudkan untuk mengekspos api minimal yang perlu dikerjakan pengguna.

Memperluas

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

Properti

sendCancellationRequest

mengirim permintaan pembatalan.

Metode yang Diwarisi

getOperationState()	Mengembalikan status operasi.
getResult()	Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.
isDone()	Mengembalikan true jika poller telah selesai melakukan polling.
isStopped()	Mengembalikan true jika poller dihentikan.
onProgress((state: TState) => void)	Memanggil panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini. Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik yang diberikan.
poll({ abortSignal?: AbortSignalLike })	Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasar selesai.
stopPolling()	Menghentikan poller. Setelah ini, tidak ada permintaan manual atau otomatis yang dapat dikirim.
toString()	Mengembalikan versi berseri operasi poller dengan memanggil metode toString operasi.

Detail Properti

sendCancellationRequest

mengirim permintaan pembatalan.

sendCancellationRequest: () => Promise<void>

Nilai Properti

() => Promise<void>

Detail Metode yang Diwarisi

getOperationState()

Mengembalikan status operasi.

function getOperationState(): TState

Mengembalikan

TState

Diwarisi Dari SimplePollerLike.getOperationState

getResult()

Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.

function getResult(): undefined | TResult

Mengembalikan

undefined | TResult

Diwarisi Dari SimplePollerLike.getResult

isDone()

Mengembalikan true jika poller telah selesai melakukan polling.

function isDone(): boolean

Mengembalikan

boolean

Diwariskan Dari SimplePollerLike.isDone

isStopped()

Mengembalikan true jika poller dihentikan.

function isStopped(): boolean

Mengembalikan

boolean

Diwariskan Dari SimplePollerLike.isStopped

onProgress((state: TState) => void)

Memanggil panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini.

Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik yang diberikan.

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

Parameter

callback

(state: TState) => void

Mengembalikan

CancelOnProgress

Diwarisi Dari SimplePollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<void>

Diwariskan Dari SimplePollerLike.polling

pollUntilDone({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasar selesai.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<TResult>

Diwarisi Dari SimplePollerLike.pollUntilDone

stopPolling()

Menghentikan poller. Setelah ini, tidak ada permintaan manual atau otomatis yang dapat dikirim.

function stopPolling()

Diwariskan Dari SimplePollerLike.stopPolling

toString()

Mengembalikan versi berseri operasi poller dengan memanggil metode toString operasi.

function toString(): string

Mengembalikan

string

Diwariskan Dari SimplePollerLike.toString