Interface Task

cancel

• cancel(): Promise<boolean>

  Cancel the current Download or Upload task.

  Example

  Cancel a task inside a state changed listener:

  task.on('state_changed', taskSnapshot => {
    console.log('Cancelling my task!');
    task.cancel();
  });
  Copy

  Returns Promise<boolean>

catch

• catch(
      onRejected: (a: ReactNativeFirebase.NativeFirebaseError) => any,
  ): Promise<any>

  Parameters

  • onRejected: (a: ReactNativeFirebase.NativeFirebaseError) => any

  Returns Promise<any>

on

• on(
      event: "state_changed",
      nextOrObserver?:
          | FirebaseStorageTypes.TaskSnapshotObserver
          | ((a: FirebaseStorageTypes.TaskSnapshot) => any)
          | null,
      error?: ((a: ReactNativeFirebase.NativeFirebaseError) => any) | null,
      complete?: (() => void) | null,
  ): () => void

  Task event handler called when state has changed on the task.

  Example

  const task = firebase
   .storage()
   .ref('/foo/bar.json')
   .writeToFile(downloadTo);
  
  task.on('state_changed', (taskSnapshot) => {
    console.log(taskSnapshot.state);
  });
  
  task.then(() => {]
    console.log('Task complete');
  })
  .catch((error) => {
    console.error(error.message);
  });
  Copy

  Parameters

  • event: "state_changed"

    The event name to handle, always state_changed.

  • OptionalnextOrObserver:
        | FirebaseStorageTypes.TaskSnapshotObserver
        | ((a: FirebaseStorageTypes.TaskSnapshot) => any)
        | null

    The optional event observer function.

  • Optionalerror: ((a: ReactNativeFirebase.NativeFirebaseError) => any) | null

    An optional JavaScript error handler.

  • Optionalcomplete: (() => void) | null

    An optional complete handler function.

  Returns () => void

pause

• pause(): Promise<boolean>

  Pause the current Download or Upload task.

  Example

  Pause a running task inside a state changed listener:

  task.on('state_changed', taskSnapshot => {
    if (taskSnapshot.state === firebase.storage.TaskState.RUNNING) {
      console.log('Pausing my task!');
      task.pause();
    }
  });
  Copy

  Returns Promise<boolean>

resume

• resume(): Promise<boolean>

  Resume the current Download or Upload task.

  Example

  Resume a previously paused task inside a state changed listener:

  task.on('state_changed', taskSnapshot => {
    // ... pause me ...
    if (taskSnapshot.state === firebase.storage.TaskState.PAUSED) {
      console.log('Resuming my task!');
      task.resume();
    }
  });
  Copy

  Returns Promise<boolean>

then

• then(
      onFulfilled?: ((a: FirebaseStorageTypes.TaskSnapshot) => any) | null,
      onRejected?: ((a: ReactNativeFirebase.NativeFirebaseError) => any) | null,
  ): Promise<any>

  Parameters

  • OptionalonFulfilled: ((a: FirebaseStorageTypes.TaskSnapshot) => any) | null
  • OptionalonRejected: ((a: ReactNativeFirebase.NativeFirebaseError) => any) | null

  Returns Promise<any>

snapshot