FirebaseStorage Framework Reference

FIRStorage

@interfaceFIRStorage:NSObject

Firebase Storage is a service that supports uploading and downloading binary objects,such as images, videos, and other files to Google Cloud Storage. Instances ofStorageare not thread-safe, but can be accessed from any thread.If you callStorage.storage(), the instance will initialize with the defaultFirebaseApp,FirebaseApp.app(), and the storage location will come from the providedGoogleService-Info.plist.If you provide a custom instance ofFirebaseApp,the storage location will be specified via theFirebaseOptions.storageBucket property.

  • The defaultStorage instance.

    returns:An instance ofStorage, configured with the defaultFirebaseApp.

    Declaration

    Objective-C

    +(FIRStorage*_Nonnull)storage;

  • A method used to createStorage instances initialized with a custom storage bucket URL.AnyStorageReferences generated from this instance ofStorage will reference filesand directories within the specified bucket.\param url Thegs:// URL to your Firebase Storage bucket.

    returns:AStorage instance, configured with the custom storage bucket.

    Declaration

    Objective-C

    +(FIRStorage*_Nonnull)storageWithURL:(NSString*_Nonnull)url;

  • Creates an instance ofStorage, configured with a customFirebaseApp.StorageReferencesgenerated from a resulting instance will reference files in the Firebase projectassociated with customFirebaseApp.\param app The customFirebaseApp used for initialization.

    returns:AStorage instance, configured with the customFirebaseApp.

    Declaration

    Objective-C

    +(FIRStorage*_Nonnull)storageForApp:(FIRApp*_Nonnull)app;

  • Creates an instance ofStorage, configured with a customFirebaseApp and a custom storagebucket URL.\param app The customFirebaseApp used for initialization.

    \param url Thegs:// url to your Firebase Storage bucket.

    returns:theStorage instance, configured with the customFirebaseApp and storage bucket URL.

    Declaration

    Objective-C

    +(FIRStorage*_Nonnull)storageForApp:(FIRApp*_Nonnull)appURL:(NSString*_Nonnull)url;

  • TheFirebaseApp associated with this Storage instance.

    Declaration

    Objective-C

    @property(nonatomic,strong,readonly)FIRApp*_Nonnullapp;

  • The maximum time in seconds to retry an upload if a failure occurs.Defaults to 10 minutes (600 seconds).

    Declaration

    Objective-C

    @property(nonatomic)NSTimeIntervalmaxUploadRetryTime;

  • The maximum time in seconds to retry a download if a failure occurs.Defaults to 10 minutes (600 seconds).

    Declaration

    Objective-C

    @property(nonatomic)NSTimeIntervalmaxDownloadRetryTime;

  • The maximum time in seconds to retry operations other than upload and download if a failure occurs.Defaults to 2 minutes (120 seconds).

    Declaration

    Objective-C

    @property(nonatomic)NSTimeIntervalmaxOperationRetryTime;

  • Specify the maximum upload chunk size. Values less than 256K (262144) will be rounded up to 256K. Valuesabove 256K will be rounded down to the nearest 256K multiple. The default is no maximum.

    Declaration

    Swift

    @objcpublicvaruploadChunkSizeBytes:Int64

  • ADispatchQueue that all developer callbacks are fired on. Defaults to the main queue.

    Declaration

    Objective-C

    @property(nonatomic,strong)dispatch_queue_t_NonnullcallbackQueue;

  • Creates aStorageReference initialized at the root Firebase Storage location.

    returns:An instance ofStorageReference referencing the root of the storage bucket.

    Declaration

    Objective-C

    -(FIRStorageReference*_Nonnull)reference;

  • Creates a StorageReference given ags://,http://, orhttps:// URL pointing to aFirebase Storage location. For example, you can pass in anhttps:// download URL retrieved fromStorageReference.downloadURL(completion:) or thegs:// URL fromStorageReference.description.\param url A gs // or https:// URL to initialize the reference with.

    throws:Throws a fatal error ifurl is not associated with theFirebaseApp used to initializethis Storage instance.

    returns:An instance of StorageReference at the given child path.

    Declaration

    Objective-C

    -(FIRStorageReference*_Nonnull)referenceForURL:(NSString*_Nonnull)url;

  • Creates aStorageReference initialized at a location specified by thepath parameter.\param path A relative path from the root of the storage bucket, for instance @“path/to/object”.

    returns:An instance ofStorageReference pointing to the given path.

    Declaration

    Objective-C

    -(FIRStorageReference*_Nonnull)referenceWithPath:(NSString*_Nonnull)path;

  • Configures the Storage SDK to use an emulated backend instead of the default remote backend.This method should be called before invoking any other methods on a new instance ofStorage.

    Declaration

    Objective-C

    -(void)useEmulatorWithHost:(NSString*_Nonnull)hostport:(NSInteger)port;

  • Undocumented

    Declaration

    Objective-C

    -(id_Nonnull)copySWIFT_WARN_UNUSED_RESULT;

  • Undocumented

    Declaration

    Objective-C

    -(BOOL)isEqual:(id_Nullable)objectSWIFT_WARN_UNUSED_RESULT;

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic,readonly)NSUIntegerhash

  • Undocumented

    Declaration

    Objective-C

    -(nonnullinstancetype)initSWIFT_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    +(nonnullinstancetype)newSWIFT_UNAVAILABLE_MSG("-init is unavailable");

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-08-23 UTC.