Products Use Cases Pricing Docs Support
Go to console
Overview Guides Reference Samples Libraries

FirebaseStorage Framework Reference

FIRStorageMetadata


@interface FIRStorageMetadata : NSObject <NSCopying>

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 FIRStorage 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 (readonly, copy, nonatomic) NSString *_Nonnull bucket;

  • Cache-Control directive for the object data.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *cacheControl;

  • Content-Disposition of the object data.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *contentDisposition;

  • Content-Encoding of the object data.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *contentEncoding;

  • Content-Language of the object data.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *contentLanguage;

  • Content-Type of the object data.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *contentType;

  • MD5 hash of the data; encoded using base64.

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

    @property (readonly, atomic) int64_t generation;

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

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable)
    NSDictionary<NSString *, NSString *> *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 (readonly, atomic) int64_t metageneration;

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

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

  • Content-Length of the data in bytes.

    Declaration

    Objective-C

    @property (readonly, atomic) int64_t size;

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

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

  • A reference to the object in Firebase Storage.

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

    - (nullable instancetype)initWithDictionary:
    (nonnull NSDictionary<NSString *, id> *)dictionary;

    Return Value

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

  • Creates an NSDictionary from the contents of the metadata.

    Declaration

    Objective-C

    - (nonnull NSDictionary<NSString *, id> *)dictionaryRepresentation;

    Return Value

    An NSDictionary that represents the contents of the metadata.

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

    Declaration

    Objective-C

    @property (readonly, getter=isFile, atomic) BOOL file;

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

    Declaration

    Objective-C

    @property (readonly, getter=isFolder, atomic) BOOL folder;