SimplePollerLike interface

الحزمة:

@azure-rest/arm-appservice

استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد.

الأساليب

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

تفاصيل الأسلوب

getOperationState()

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

function getOperationState(): TState

المرتجعات

TState

getResult()

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

function getResult(): undefined | TResult

المرتجعات

undefined | TResult

isDone()

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

function isDone(): boolean

المرتجعات

boolean

isStopped()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use abortSignal status to track this instead.

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

function isStopped(): boolean

المرتجعات

boolean

onProgress((state: TState) => void)

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

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

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

المعلمات

callback

(state: TState) => void

المرتجعات

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

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

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

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

المعلمات

pollOptions

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TResult>

serialize()

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

function serialize(): Promise<string>

المرتجعات

Promise<string>

stopPolling()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use abortSignal to stop polling instead.

يمنع الاستقصاء من المتابعة إلى الاستقصاء. يرجى ملاحظة أن هذا سيؤدي فقط إلى إيقاف التحقق من جانب العميل

function stopPolling()

submitted()

انتظر التحقق ليتم إرساله.

function submitted(): Promise<void>

المرتجعات

Promise<void>

toString()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use serialize() instead.

إرجاع تمثيل سلسلة لعملية الاستقصاء. مشابهة لتسلسل ولكن إرجاع سلسلة.

function toString(): string

المرتجعات

string