Blog Studio Go to console

FirebaseStorage Framework Reference

FIRStorageTaskSnapshot


@interface FIRStorageTaskSnapshot : NSObject

StorageTaskSnapshot represents an immutable view of a task. A snapshot contains a task, storage reference, metadata (if it exists), progress, and an error (if one occurred).

  • The task this snapshot represents.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) FIRStorageTask *_Nonnull task;

  • Metadata returned by the task, or nil if no metadata returned.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) FIRStorageMetadata *_Nullable metadata;

  • The StorageReference this task operates on.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) FIRStorageReference *_Nonnull reference;

  • An object which tracks the progress of an upload or download.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSProgress *_Nullable progress;

  • An error raised during task execution, or nil if no error occurred.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSError *_Nullable error;

  • The status of the task.

    Declaration

    Objective-C

    @property (nonatomic, readonly) enum FIRStorageTaskStatus status;

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly, copy) NSString * _Nonnull description

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init SWIFT_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");