React Native Firebase
    Preparing search index...

    Interface FullMetadata

    The full readable metadata returned by TaskSnapshot.metadata or StorageReference.getMetadata().

    Use the exported types directly instead. FirebaseStorageTypes namespace is kept for backwards compatibility.

    interface FullMetadata {
        bucket: string;
        cacheControl?: string;
        contentDisposition?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        contentType?: string;
        customMetadata?: { [key: string]: string };
        downloadTokens: string[] | undefined;
        fullPath: string;
        generation: string;
        md5Hash?: string;
        metageneration: string;
        name: string;
        ref?: FirebaseStorageTypes.Reference;
        size: number;
        timeCreated: string;
        updated: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bucket cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? customMetadata? downloadTokens fullPath generation md5Hash? metageneration name ref? size timeCreated updated

    Properties

    bucket: string

    The bucket this storage object is contained in.

    gs://my-project-storage-bucket
    cacheControl?: string

    The 'Cache-Control' HTTP header that will be set on the storage object when it's requested.

    To turn off caching, you can set the following cacheControl value.

    {
      cacheControl: 'no-store',
    }

    To aggressively cache an object, e.g. static assets, you can set the following cacheControl value.

    {
      cacheControl: 'public, max-age=31536000',
    }

    Learn more about this header on Mozilla.

    contentDisposition?: string

    The 'Content-Disposition' HTTP header that will be set on the storage object when it's requested.

    Learn more about this header on Mozilla.

    contentEncoding?: string

    The 'Content-Encoding' HTTP header that will be used on the storage object when it's requested.

    Learn more about this header on Mozilla.

    contentLanguage?: string

    The 'Content-Language' HTTP header that will be set on the storage object when it's requested.

    Learn more about this header on Mozilla.

    contentType?: string

    The 'Content-Type' HTTP header that will be set on the object when it's requested.

    This is used to indicate the media type (or MIME type) of the object. When uploading a file Firebase Cloud Storage for React Native will attempt to automatically detect this if contentType is not already set, if it fails to detect a media type it will default to application/octet-stream.

    For DATA_URL string formats uploaded via putString this will also be automatically extracted if available.

    Setting the content type as JSON, e.g. for when uploading a JSON string via putString.

    {
      contentType: 'application/json',
    }

    Learn more about this header on Mozilla.

    customMetadata?: { [key: string]: string }

    Additional user-defined custom metadata for this storage object.

    All values must be strings.

    Adding a user controlled NSFW meta data field.

    {
      customMetadata: {
        'nsfw': 'true'
      },
    downloadTokens: string[] | undefined

    Tokens to allow access to the download URL.

    fullPath: string

    The full path to this storage object in its bucket.

    invertase/logo.png
    generation: string

    Storage object generation values enable users to uniquely identify data resources, e.g. object versioning.

    Read more on generation on the Google Cloud Storage documentation.

    md5Hash?: string

    A Base64-encoded MD5 hash of the object being uploaded.

    metageneration: string

    Storage object metageneration values enable users to uniquely identify data resources, e.g. object versioning.

    Read more on metageneration on the Google Cloud Storage documentation.

    name: string

    The short name of storage object in its bucket, e.g. it's file name.

    logo.png
    ref?: FirebaseStorageTypes.Reference

    StorageReference associated with this upload.

    size: number

    The size of this storage object in bytes.

    timeCreated: string

    A date string representing when this storage object was created.

    2019-05-02T00:34:56.264Z
    updated: string

    A date string representing when this storage object was last updated.

    2019-05-02T00:35:56.264Z

    Settings

    Member Visibility

    On This Page

    Properties