FirebaseStorage Framework Reference

StorageMetadata

@objc(FIRStorageMetadata)
open class StorageMetadata : 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 in the GCS documentation

  • The name of the bucket containing this object.

    Declaration

    Swift

    @objc
    public let bucket: String
  • Cache-Control directive for the object data.

    Declaration

    Swift

    @objc
    public var cacheControl: String?
  • Content-Disposition of the object data.

    Declaration

    Swift

    @objc
    public var contentDisposition: String?
  • Content-Encoding of the object data.

    Declaration

    Swift

    @objc
    public var contentEncoding: String?
  • Content-Language of the object data.

    Declaration

    Swift

    @objc
    public var contentLanguage: String?
  • Content-Type of the object data.

    Declaration

    Swift

    @objc
    public var contentType: String?
  • MD5 hash of the data; encoded using base64.

    Declaration

    Swift

    @objc
    public let md5Hash: String?
  • The content generation of this object. Used for object versioning.

    Declaration

    Swift

    @objc
    public let generation: Int64
  • User-provided metadata, in key/value pairs.

    Declaration

    Swift

    @objc
    public var customMetadata: [String : String]?
  • 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

    Swift

    @objc
    public let metageneration: Int64
  • The name of this object, in gs://bucket/path/to/object.txt, this is object.txt.

    Declaration

    Swift

    @objc
    public internal(set) var name: String? { get }
  • The full path of this object, in gs://bucket/path/to/object.txt, this is path/to/object.txt.

    Declaration

    Swift

    @objc
    public internal(set) var path: String? { get }
  • Content-Length of the data in bytes.

    Declaration

    Swift

    @objc
    public let size: Int64
  • The creation time of the object in RFC 3339 format.

    Declaration

    Swift

    @objc
    public let timeCreated: Date?
  • The modification time of the object metadata in RFC 3339 format.

    Declaration

    Swift

    @objc
    public let updated: Date?
  • Never used API

    Declaration

    Swift

    @available(*, deprecated)
    @objc
    public let storageReference: StorageReference?
  • Creates a Dictionary from the contents of the metadata. @return A Dictionary that represents the contents of the metadata.

    Declaration

    Swift

    @objc
    open func dictionaryRepresentation() -> [String : AnyHashable]
  • Determines if the current metadata represents a “file”.

    Declaration

    Swift

    @objc
    public var isFile: Bool { get }
  • Determines if the current metadata represents a “folder”.

    Declaration

    Swift

    @objc
    public var isFolder: Bool { get }
  • Creates an empty instance of StorageMetadata. @return An empty instance of StorageMetadata.

    Declaration

    Swift

    override public convenience init()
  • Creates an instance of StorageMetadata from the contents of a dictionary. @return An instance of StorageMetadata that represents the contents of a dictionary.

    Declaration

    Swift

    @objc
    public init(dictionary: [String : AnyHashable])
  • Undocumented

    Declaration

    Swift

    override open func copy() -> Any
  • Undocumented

    Declaration

    Swift

    override open func isEqual(_ object: Any?) -> Bool
  • Undocumented

    Declaration

    Swift

    override public var hash: Int { get }
  • Undocumented

    Declaration

    Swift

    override public var description: String { get }