UploadTask interface

מייצג את תהליך העלאת אובייקט. מאפשר לך לפקח ולנהל את ההעלאה.

חֲתִימָה:

export interface UploadTask 

נכסים

תכונה	סוּג	תיאור
תמונת מצב	UploadTaskSnapshot	תמונת מצב של המשימה הנוכחית.

שיטות

שיטה	תיאור
לְבַטֵל()	מבטל משימה רצה. אין השפעה על משימה שלמה או שנכשלה.
לתפוס (בנדחה)	שווה ערך לקריאה then(null, onRejected) .
on(event, nextOrObserver, error, complete)	מאזין לאירועים במשימה זו. לאירועים יש שלוש פונקציות התקשרות חוזרת (המכונה next , error complete ). אם רק האירוע מועבר, מוחזרת פונקציה שניתן להשתמש בה לרישום החזרות. אחרת, ההתקשרויות חוזרות מועברות לאחר האירוע. ניתן להעביר התקשרויות חוזרות כשלושה ארגומנטים נפרדים או כמאפייני next , error complete של אובייקט. כל אחת משלושת ההתקשרות חזרה היא אופציונלית, כל עוד צוין לפחות אחת. בנוסף, כאשר אתה מוסיף את ההתקשרות שלך, אתה מקבל פונקציה בחזרה. אתה יכול לקרוא לפונקציה זו כדי לבטל את רישום ההתקשרות החוזרות המשויכות.
הַפסָקָה()	משהה משימה הפועלת כעת. אין השפעה על משימה שהושהה או נכשלה.
קורות חיים()	ממשיך משימה מושהית. אין השפעה על משימה שפועלת כעת או נכשלה.
then(onFulfilled, onRejected)	האובייקט הזה מתנהג כמו הבטחה, ופותר עם נתוני תמונת המצב שלו כשההעלאה מסתיימת.

UploadTask.snapshot

תמונת מצב של המשימה הנוכחית.

חֲתִימָה:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

מבטל משימה רצה. אין השפעה על משימה שלמה או שנכשלה.

חֲתִימָה:

cancel(): boolean;

החזרות:

בוליאני

נכון אם הביטול השפיע.

UploadTask.catch()

שווה ערך להתקשרות then(null, onRejected) .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
על נדחה	(שגיאה: StorageError ) => לא ידוע

החזרות:

הבטחה<לא ידוע>

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>;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
מִקרֶה	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();
});

UploadTask.pause()

משהה משימה הפועלת כעת. אין השפעה על משימה שהושהה או נכשלה.

חֲתִימָה:

pause(): boolean;

החזרות:

בוליאני

נכון אם הפעולה נכנסה לתוקף, לא נכון אם מתעלמים ממנה.

UploadTask.resume()

ממשיך משימה מושהית. אין השפעה על משימה שפועלת כעת או נכשלה.

חֲתִימָה:

resume(): boolean;

החזרות:

בוליאני

נכון אם הפעולה נכנסה לתוקף, לא נכון אם מתעלמים ממנה.

UploadTask.then()

האובייקט הזה מתנהג כמו הבטחה, ופותר עם נתוני תמונת המצב שלו כשההעלאה מסתיימת.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
על מילא	((תמונה: UploadTaskSnapshot ) => לא ידוע) | ריק	ההתקשרות חזרה. שרשור הבטחות עובד כרגיל.
על נדחה	((שגיאה: StorageError ) => לא ידוע) | ריק	החזרה לדחייה.

החזרות:

הבטחה<לא ידוע>