PollerLike interface

الحزمة:

@azure/ai-language-text

تمثيل تجريدي للمطلع، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.

يمتد

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

الخصائص

sendCancellationRequest

يرسل طلب إلغاء.

الأساليب المتوارثة

getOperationState()	إرجاع حالة العملية.
getResult()	إرجاع قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن ترجع شكلا غير معرف أو غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.
isDone()	إرجاع true إذا انتهى الاستقصاء من الاستقصاء.
isStopped()	إرجاع true إذا تم إيقاف الاستقصاء.
onProgress((state: TState) => void)	استدعاء رد الاتصال المتوفر بعد اكتمال كل استقصاء، وإرسال الحالة الحالية لعملية الاستقصاء. يقوم بإرجاع أسلوب يمكن استخدامه لإيقاف تلقي التحديثات على دالة رد الاتصال المحددة.
poll({ abortSignal?: AbortSignalLike })	إرجاع وعد سيتم حله بمجرد انتهاء طلب استقصاء واحد. يقوم بذلك عن طريق استدعاء أسلوب التحديث لعملية Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	إرجاع وعد سيتم حله بمجرد اكتمال العملية الأساسية.
stopPolling()	يوقف المدقق. بعد ذلك، لا يمكن إرسال أي طلبات يدوية أو تلقائية.
toString()	إرجاع إصدار متسلسل من عملية الاستقصاء عن طريق استدعاء أسلوب toString الخاص بالعملية.

تفاصيل الخاصية

sendCancellationRequest

يرسل طلب إلغاء.

sendCancellationRequest: () => Promise<void>

قيمة الخاصية

() => Promise<void>

تفاصيل الأساليب المتوارثة

getOperationState()

إرجاع حالة العملية.

function getOperationState(): TState

المرتجعات

TState

موروث من SimplePollerLike.getOperationState

getResult()

إرجاع قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن ترجع شكلا غير معرف أو غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.

function getResult(): undefined | TResult

المرتجعات

undefined | TResult

موروث من SimplePollerLike.getResult

isDone()

إرجاع true إذا انتهى الاستقصاء من الاستقصاء.

function isDone(): boolean

المرتجعات

boolean

موروث من SimplePollerLike.isDone

isStopped()

إرجاع true إذا تم إيقاف الاستقصاء.

function isStopped(): boolean

المرتجعات

boolean

موروث من SimplePollerLike.isStopped

onProgress((state: TState) => void)

استدعاء رد الاتصال المتوفر بعد اكتمال كل استقصاء، وإرسال الحالة الحالية لعملية الاستقصاء.

يقوم بإرجاع أسلوب يمكن استخدامه لإيقاف تلقي التحديثات على دالة رد الاتصال المحددة.

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

المعلمات

callback

(state: TState) => void

المرتجعات

CancelOnProgress

موروث من SimplePollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

إرجاع وعد سيتم حله بمجرد انتهاء طلب استقصاء واحد. يقوم بذلك عن طريق استدعاء أسلوب التحديث لعملية Poller.

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

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<void>

موروث من SimplePollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

إرجاع وعد سيتم حله بمجرد اكتمال العملية الأساسية.

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

المعلمات

pollOptions

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TResult>

موروثة من SimplePollerLike.pollUntilDone

stopPolling()

يوقف المدقق. بعد ذلك، لا يمكن إرسال أي طلبات يدوية أو تلقائية.

function stopPolling()

موروث من SimplePollerLike.stopPolling

toString()

إرجاع إصدار متسلسل من عملية الاستقصاء عن طريق استدعاء أسلوب toString الخاص بالعملية.

function toString(): string

المرتجعات

string

موروث من SimplePollerLike.toString