UploadTask interface

Представляет процесс загрузки объекта. Позволяет отслеживать и управлять загрузкой.

Подпись:

export interface UploadTask

Характеристики

Свойство Тип Описание
снимок Загрузить снимок задачи Снимок текущего состояния задачи.

Методы

Метод Описание
отмена() Отменяет запущенную задачу. Не влияет на завершенное или невыполненное задание.
поймать (onRejected) Эквивалентно вызову then(null, onRejected) .
on(событие, nextOrObserver, ошибка, завершено) Прослушивает события по этой задаче. События имеют три функции обратного вызова (называемые next , error и complete ). Если передается только событие, возвращается функция, которую можно использовать для регистрации обратных вызовов. В противном случае обратные вызовы передаются после события. Обратные вызовы могут передаваться либо как три отдельных аргумента , либо как свойства next , error и complete объекта. Любой из трех обратных вызовов не является обязательным, если указан хотя бы один. Кроме того, когда вы добавляете свои обратные вызовы, вы получаете обратно функцию. Вы можете вызвать эту функцию, чтобы отменить регистрацию связанных обратных вызовов.
пауза() Приостанавливает текущую задачу. Не влияет на приостановленную или невыполненную задачу.
резюме() Возобновляет приостановленную задачу. Не влияет на текущую запущенную или невыполненную задачу.
тогда (onFulfilled, onRejected) Этот объект ведет себя как обещание и разрешается с помощью данных моментального снимка после завершения загрузки.

ЗагрузитьTask.snapshot

Снимок текущего состояния задачи.

Подпись:

snapshot: UploadTaskSnapshot;

ЗагрузитьЗадачу.отмена()

Отменяет запущенную задачу. Не влияет на завершенное или невыполненное задание.

Подпись:

cancel(): boolean;

Возврат:

логическое значение

Истинно, если отмена имела эффект.

ЗагрузитьЗадачу.catch()

Эквивалентно вызову then(null, onRejected) .

Подпись:

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

Параметры

Параметр Тип Описание
onRejected (ошибка: StorageError ) => неизвестно

Возврат:

Обещание <неизвестно>

ЗагрузитьЗадачу.он()

Прослушивает события по этой задаче.

События имеют три функции обратного вызова (называемые 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 Тип события, которое нужно прослушивать.
следующийOrObserver ХранилищеОбсервер < Снимок задачи загрузки > | ноль | ((снимок: UploadTaskSnapshot ) => неизвестно) next функция, которая вызывается для каждого элемента в потоке событий или объекта-наблюдателя с некоторыми или всеми из этих трех свойств ( next , error , complete ).
ошибка ((а: Ошибка хранения ) => неизвестно) | нулевой Функция, которая вызывается с ошибкой StorageError , если поток событий завершается из-за ошибки.
полный Отписаться | нулевой

Возврат:

Отписаться | Подписаться < Снимок задачи загрузки >

Если передается только аргумент события, возвращает функцию, которую можно использовать для добавления обратных вызовов (см. примеры выше). Если передается не только аргумент события, возвращает функцию, которую вы можете вызвать, чтобы отменить регистрацию обратных вызовов.

Пример 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();
});

ЗагрузитьЗадачу.пауза()

Приостанавливает текущую задачу. Не влияет на приостановленную или невыполненную задачу.

Подпись:

pause(): boolean;

Возврат:

логическое значение

True, если операция вступила в силу, и false, если она игнорируется.

ЗагрузитьЗадачу.резюме()

Возобновляет приостановленную задачу. Не влияет на текущую запущенную или невыполненную задачу.

Подпись: 

resume(): boolean;

Возврат:

логическое значение

True, если операция вступила в силу, и false, если она игнорируется.

ЗагрузитьЗадачу.тогда()

Этот объект ведет себя как обещание и разрешается с помощью данных своего снимка после завершения загрузки.

Подпись: 

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

Параметры

Параметр Тип Описание
onВыполнено ((снимок: UploadTaskSnapshot ) => неизвестно) | нулевой Обратный вызов выполнения. Цепочка обещаний работает как обычно.
onRejected ((ошибка: StorageError ) => неизвестно) | нулевой Обратный вызов отклонения.

Возврат:

Обещание <неизвестно>