PollerLikeWithCancellation interface

الحزمة:

@azure/storage-blob

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

الأساليب

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

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

cancelOperation({ abortSignal?: AbortSignalLike })

محاولات إلغاء العملية الأساسية.

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

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<void>

getOperationState()

إرجاع حالة العملية. يمكن أن تكون TState المعرفة في PollerLike مجموعة فرعية من TState المحددة في تنفيذ Poller.

function getOperationState(): TState

المرتجعات

TState

getResult()

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

function getResult(): undefined | TResult

المرتجعات

undefined | TResult

isDone()

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

function isDone(): boolean

المرتجعات

boolean

isStopped()

إرجاع 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<void>

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<void>

pollUntilDone()

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

function pollUntilDone(): Promise<TResult>

المرتجعات

Promise<TResult>

stopPolling()

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

function stopPolling()

toString()

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

function toString(): string

المرتجعات

string