FirebaseStorage Framework Reference

FIRStorageMetadata


@interface FIRStorageMetadata : NSObject

Class which represents the metadata on an object in Firebase Storage. This metadata is returned on successful operations, and can be used to retrieve download URLs, content types, and a Storage reference to the object in question. Full documentation can be found at the GCS Objects#resource docs.

See

https://cloud.google.com/storage/docs/json_api/v1/objects#resource

  • The name of the bucket containing this object.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull bucket;

  • Cache-Control directive for the object data.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nullable cacheControl;

  • Content-Disposition of the object data.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nullable contentDisposition;

  • Content-Encoding of the object data.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nullable contentEncoding;

  • Content-Language of the object data.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nullable contentLanguage;

  • Content-Type of the object data.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nullable contentType;

  • MD5 hash of the data; encoded using base64.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nullable md5Hash;

  • The content generation of this object. Used for object versioning.

    Declaration

    Objective-C

    @property (nonatomic, readonly) int64_t generation;

  • User-provided metadata, in key/value pairs.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSDictionary<NSString *, NSString *> *_Nullable customMetadata;

  • The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.

    Declaration

    Objective-C

    @property (nonatomic, readonly) int64_t metageneration;

  • The name of this object, in gs://bucket/path/to/object.txt, this is object.txt.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nullable name;

  • The full path of this object, in gs://bucket/path/to/object.txt, this is path/to/object.txt.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nullable path;

  • Content-Length of the data in bytes.

    Declaration

    Objective-C

    @property (nonatomic, readonly) int64_t size;

  • The creation time of the object in RFC 3339 format.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSDate *_Nullable timeCreated;

  • The modification time of the object metadata in RFC 3339 format.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSDate *_Nullable updated;

  • Never used API

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) SWIFT_DEPRECATED FIRStorageReference *storageReference;

  • Creates a Dictionary from the contents of the metadata.

    Declaration

    Objective-C

    - (NSDictionary<NSString *, NSObject *> *_Nonnull)dictionaryRepresentation;

    Return Value

    A Dictionary that represents the contents of the metadata.

  • Determines if the current metadata represents a “file”.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isFile;

  • Determines if the current metadata represents a “folder”.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isFolder;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Creates an instance of StorageMetadata from the contents of a dictionary.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDictionary:
    (NSDictionary<NSString *, NSObject *> *_Nonnull)dictionary;

    Return Value

    An instance of StorageMetadata that represents the contents of a dictionary.

  • Undocumented

    Declaration

    Objective-C

    - (id _Nonnull)copy SWIFT_WARN_UNUSED_RESULT;

  • Undocumented

    Declaration

    Objective-C

    - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT;

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger hash

  • Undocumented

    Declaration

    Objective-C

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