FIRStorage Class Reference

#import <FIRStorage.h>

Inheritance diagram for FIRStorage:

Instance Methods
(FIRStorageReference *)	- reference
(FIRStorageReference *)	- referenceForURL:
(FIRStorageReference *)	- referenceWithPath:

Class Methods
(storage()	+ NS_SWIFT_NAME
(instancetype)	+ storageForApp:

Properties
FIRApp *	app
NSTimeInterval	maxUploadRetryTime
NSTimeInterval	maxDownloadRetryTime
NSTimeInterval	maxOperationRetryTime
dispatch_queue_t	callbackQueue

Detailed Description

FirebaseStorage is a service that supports uploading and downloading binary objects, such as images, videos, and other files to Google Cloud Storage.

If you call [FIRStorage storage], the instance will initialize with the default FIRApp, [FIRApp defaultApp], and the storage location will come from the provided GoogleService-Info.plist.

If you call [FIRStorage storageForApp:] and provide a custom instance of FIRApp, the storage location will be specified via the FIROptions::storageBucket property.

Method Documentation

+ (storage() NS_SWIFT_NAME

Creates an instance of FIRStorage, configured with the default FIRApp.

Returns

the FIRStorage instance, initialized with the default FIRApp.

- (FIRStorageReference *) reference

Creates a FIRStorageReference initialized at the root Firebase Storage location.

Returns

An instance of FIRStorageReference initialized at the root.

- (FIRStorageReference *) referenceForURL:

(NSString *)

string

Creates a FIRStorageReference given a gs:// or https:// URL pointing to a Firebase Storage location. For example, you can pass in an https:// download URL retrieved from [FIRStorageReference getDownloadURL] or the gs:// URI from [FIRStorageReference description].

Parameters

string

A gs:// or https:// URL to initialize the reference with.

Returns

An instance of FIRStorageReference at the given child path.

Exceptions

Throws

an exception if passed in URL is not associated with the FIRApp used to initialize this FIRStorage.

- (FIRStorageReference *) referenceWithPath:

(NSString *)

string

Creates a FIRStorageReference initialized at a child Firebase Storage location.

Parameters

string

A relative path from the root to initialize the reference with, for instance "path/to/object".

Returns

An instance of FIRStorageReference at the given child path.

+ (instancetype) storageForApp:

(storage(app:))

NS_SWIFT_NAME

Creates an instance of FIRStorage, configured with the custom FIRApp app.

Parameters

app	The custom FIRApp used for initialization.

Returns

the FIRStorage instance, initialized with the custom FIRApp.

Property Documentation

- (FIRApp*) app

readnonatomicstrong

The Firebase App associated with this Firebase Storage instance.

- (dispatch_queue_t) callbackQueue

readwritenonatomicstrong

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

- (NSTimeInterval) maxDownloadRetryTime

readwriteatomic

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

- (NSTimeInterval) maxOperationRetryTime

readwriteatomic

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

- (NSTimeInterval) maxUploadRetryTime

readwriteatomic

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

---

The documentation for this class was generated from the following file:

• Frameworks/FirebaseStorage.framework/Headers/FIRStorage.h