UploadTask interface

يمثّل هذا النوع عملية تحميل عنصر. تسمح لك بمراقبة عملية التحميل وإدارتها.

Signature:

export interface UploadTask 

أماكن إقامة

الموقع	النوع	الوصف
لقطة	UploadTaskShot	لقطة عن حالة المهمة الحالية.

الطُرق

الطريقة	الوصف
cancel()	إلغاء مهمة قيد التشغيل ليس له أي تأثير في مهمّة مكتملة أو غير ناجحة.
catch(on المعنيّ)	يعادل استدعاء then(null, onRejected).
on(event, nextOrObserver, error, complete)	وترصد الأحداث في هذه المهمة.تحتوي الأحداث على ثلاث دوال استدعاء (يُشار إليها باسم next وerror وcomplete).في حال تمرير الحدث فقط، يتم عرض دالة يمكن استخدامها لتسجيل عمليات الاستدعاء. وبخلاف ذلك، يتم تمرير الاستدعاءات بعد الحدث.يمكن تمرير عمليات الاستدعاء إما كثلاث وسيطات منفصلة أو كسمات next وerror وcomplete لكائن. تكون أي من عمليّات الاستدعاء الثلاث اختيارية، طالما أنّ عملية معاودة الاتصال محددة واحدة على الأقل. بالإضافة إلى ذلك، عند إضافة عمليات الاستدعاء، تحصل على دالة مرة أخرى. يمكنك استدعاء هذه الدالة لإلغاء تسجيل عمليات معاودة الاتصال المرتبطة.
pause()	إيقاف مهمة قيد التشغيل حاليًا مؤقتًا. ليس له أي تأثير في مهمّة تمّ إيقافها مؤقتًا أو تعذّر تنفيذها.
resume()	استئناف مهمة متوقفة مؤقتًا ليس له أي تأثير في مهمة قيد التشغيل حاليًا أو لم تنجح.
then(onFulfill, onتف يرجى)	ويتصرف هذا الكائن كالتعهد، ويتم التعامل معه باستخدام بيانات اللقطة عند اكتمال التحميل.

تحميلTask.snapshot

لقطة عن حالة المهمة الحالية.

Signature:

snapshot: UploadTaskSnapshot;

uploadTask.cancel()

إلغاء مهمة قيد التشغيل ليس له أي تأثير في مهمّة مكتملة أو غير ناجحة.

Signature:

cancel(): boolean;

المرتجعات:

قيمة منطقية

صحيح إذا كان للإلغاء أي تأثير.

UploadTask.catch()

يعادل استدعاء then(null, onRejected).

Signature:

catch(onRejected: (error: StorageError) => unknown): Promise<unknown>;

المَعلمات

المعلمة	النوع	الوصف
onمرفوض	(خطأ: StorageError) => غير معروفة

المرتجعات:

الوعد<غير معروف>

UploadTask.on()

للاستماع إلى الأحداث في هذه المهمة

تحتوي الأحداث على ثلاث دوال معاودة الاتصال (يُشار إليها باسم next وerror وcomplete).

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

يمكن تمرير عمليات الاستدعاء إما كثلاث وسيطات منفصلة أو كسمات next وerror وcomplete لكائن. تكون أي من عمليّات الاستدعاء الثلاث اختيارية، طالما أنّ عملية معاودة الاتصال محددة واحدة على الأقل. بالإضافة إلى ذلك، عند إضافة عمليات الاستدعاء، تحصل على دالة مرة أخرى. يمكنك استدعاء هذه الدالة لإلغاء تسجيل عمليات معاودة الاتصال المرتبطة.

Signature:

on(event: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, complete?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;

المَعلمات

المعلمة	النوع	الوصف
حدث	TaskEvent	نوع الحدث المطلوب الاستماع إليه.
NextOrObserver	StorageObserver<UploadTaskSnapshot> | null | ((لقطة: UploadTaskSnapshot) => غير معروفة)	الدالة next، التي يتم استدعاؤها لكل عنصر في تدفق الأحداث، أو كائن مراقب يتضمّن بعض هذه السمات الثلاث أو جميعها (next، error، complete).
خطأ	((أ: StorageError) => غير معروف) | فارغ	دالة يتم استدعاءها مع StorageError في حال انتهاء بث الحدث بسبب خطأ.
مكتمل	إلغاء الاشتراك | فارغ

المرتجعات:

إلغاء الاشتراك | اشتراك<UploadTaskSnapshot>

إذا تم تمرير وسيطة الحدث فقط، يتم عرض دالة يمكنك استخدامها لإضافة استدعاءات (راجع الأمثلة أعلاه). إذا تم تمرير وسيطة الحدث أكثر من مجرد وسيطة الحدث، يتم عرض دالة يمكنك استدعاؤها لإلغاء تسجيل عمليات الاستدعاء.

مثال 1

**تمرير عمليات الاستدعاء بشكل منفصل أو ضمن كائن.**

var next = function(snapshot) {};
var error = function(error) {};
var complete = function() {};

// The first example.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    next,
    error,
    complete);

// This is equivalent to the first example.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'next': next,
  'error': error,
  'complete': complete
});

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe(next, error, complete);

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe({
  'next': next,
  'error': error,
  'complete': complete
});

مثال 2

**تكون أي معاودة اتصال اختيارية.**

// Just listening for completion, this is legal.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    null,
    null,
    function() {
      console.log('upload complete!');
    });

// Just listening for progress/state changes, this is legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
});

// This is also legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'complete': function() {
    console.log('upload complete!');
  }
});

مثال 3

**استخدم الدالة التي تم إرجاعها لإزالة الاستدعاءات.**

var unsubscribe = uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    function(snapshot) {
      var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
      console.log(percent + "% done");
      // Stop after receiving one update.
      unsubscribe();
    });

// This code is equivalent to the above.
var handle = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
unsubscribe = handle(function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
  // Stop after receiving one update.
  unsubscribe();
});

DownloadTask.pause()

إيقاف مهمة قيد التشغيل حاليًا مؤقتًا. ليس له أي تأثير في مهمّة تمّ إيقافها مؤقتًا أو تعذّر تنفيذها.

Signature:

pause(): boolean;

المرتجعات:

قيمة منطقية

True في حالة دخول العملية حيز التنفيذ، ويتم اختيار false في حالة تجاهلها.

UploadTask.resume()

استئناف مهمة متوقفة مؤقتًا ليس له أي تأثير في مهمة قيد التشغيل حاليًا أو لم تنجح.

Signature:

resume(): boolean;

المرتجعات:

قيمة منطقية

True في حالة دخول العملية حيز التنفيذ، ويتم اختيار false في حالة تجاهلها.

واجهة برمجة التطبيقات (UploadTask.then())

ويتصرف هذا الكائن كالتعهد، ويتم التعامل معه باستخدام بيانات اللقطة عند اكتمال التحميل.

Signature:

then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: StorageError) => unknown) | null): Promise<unknown>;

المَعلمات

المعلمة	النوع	الوصف
تم إنجازه	((لقطة: UploadTaskSnapshot) => غير معروفة) | فارغ	تمثّل هذه السمة معاودة الاتصال لعملية التنفيذ. تعمل سلسلة التعهدات على النحو المعتاد.
onمرفوض	((خطأ: StorageError) => غير معروف) | فارغ	معاودة الاتصال بالرفض

المرتجعات:

الوعد<غير معروف>