Interface UploadTask

cancel

• cancel(): Promise<boolean>

  Cancels a running task. Has no effect on a complete or failed task.

  Returns Promise<boolean>

  True if the cancel had an effect.

catch

• catch(
      onRejected: (error: ReactNativeFirebase.NativeFirebaseError) => unknown,
  ): Promise<unknown>

  Equivalent to calling then(null, onRejected).

  Parameters

  • onRejected: (error: ReactNativeFirebase.NativeFirebaseError) => unknown

  Returns Promise<unknown>

on

• on(
      event: "state_changed",
      nextOrObserver?:
          | StorageObserver<UploadTaskSnapshot>
          | ((snapshot: UploadTaskSnapshot) => unknown)
          | null,
      error?:
          | ((error: ReactNativeFirebase.NativeFirebaseError) => unknown)
          | null,
      complete?: CompleteFn | null,
  ): Unsubscribe | Subscribe<UploadTaskSnapshot>

  Listens for events on this task.

  Parameters

  • event: "state_changed"
  • OptionalnextOrObserver:
        | StorageObserver<UploadTaskSnapshot>
        | ((snapshot: UploadTaskSnapshot) => unknown)
        | null
  • Optionalerror: ((error: ReactNativeFirebase.NativeFirebaseError) => unknown) | null
  • Optionalcomplete: CompleteFn | null

  Returns Unsubscribe | Subscribe<UploadTaskSnapshot>

  If only the event argument is passed, returns a function you can use to add callbacks. Otherwise returns a function you can call to unregister the callbacks.

pause

• pause(): Promise<boolean>

  Pauses a currently running task. Has no effect on a paused or failed task.

  Returns Promise<boolean>

  True if the operation took effect, false if ignored.

resume

• resume(): Promise<boolean>

  Resumes a paused task. Has no effect on a currently running or failed task.

  Returns Promise<boolean>

  True if the operation took effect, false if ignored.

then

• then(
      onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null,
      onRejected?:
          | ((error: ReactNativeFirebase.NativeFirebaseError) => unknown)
          | null,
  ): Promise<unknown>

  This object behaves like a Promise, and resolves with its snapshot data when the upload completes.

  Parameters

  • OptionalonFulfilled: ((snapshot: UploadTaskSnapshot) => unknown) | null
  • OptionalonRejected: ((error: ReactNativeFirebase.NativeFirebaseError) => unknown) | null

  Returns Promise<unknown>

snapshot