UploadTask interface

يمثل عملية تحميل كائن. يسمح لك بمراقبة وإدارة التحميل.

إمضاء:

export interface UploadTask 

ملكيات

ملكية	يكتب	وصف
لمحة	تحميل مهمةSnapshot	لقطة لحالة المهمة الحالية.

طُرق

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

UploadTask.snapshot

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

إمضاء:

snapshot: UploadTaskSnapshot;

تحميل المهمة. إلغاء ()

يلغي مهمة قيد التشغيل. ليس له أي تأثير على مهمة كاملة أو فاشلة.

إمضاء:

cancel(): boolean;

عائدات:

منطقية

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

UploadTask.catch()

أي ما يعادل الاتصال then(null, onRejected) .

إمضاء:

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

حدود

معامل	يكتب	وصف
onRejected	(خطأ: خطأ في التخزين ) => غير معروف

عائدات:

وعد<مجهول>

UploadTask.on()

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

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

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

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

إمضاء:

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

حدود

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

عائدات:

إلغاء الاشتراك | يشترك < تحميل مهمةSnapshot >

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

مثال 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();
});

UploadTask.pause()

يقوم بإيقاف مهمة قيد التشغيل مؤقتًا. ليس له أي تأثير على مهمة متوقفة مؤقتًا أو فاشلة.

إمضاء:

pause(): boolean;

عائدات:

منطقية

صحيح إذا دخلت العملية حيز التنفيذ، وخطأ إذا تم تجاهلها.

UploadTask.resume()

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

إمضاء:

resume(): boolean;

عائدات:

منطقية

صحيح إذا دخلت العملية حيز التنفيذ، وخطأ إذا تم تجاهلها.

تحميل المهمة. ثم ()

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

إمضاء:

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

حدود

معامل	يكتب	وصف
على الوفاء	((لقطة: UploadTaskSnapshot ) => غير معروف) | باطل	رد الاتصال الوفاء. تسلسل الوعد يعمل كالمعتاد.
onRejected	((خطأ: خطأ في التخزين ) => غير معروف) | باطل	رد الرفض.

عائدات:

وعد<مجهول>