Package | com.distriqt.extension.firebase.storage |
Class | public final class FirebaseStorage |
Inheritance | FirebaseStorage ![]() |
This class represents the storage extension.
Property | Defined By | ||
---|---|---|---|
implementation : String [read-only]
The implementation currently in use. | FirebaseStorage | ||
isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| FirebaseStorage | ||
nativeVersion : String [read-only]
The native version string of the native extension. | FirebaseStorage | ||
service : FirebaseStorage [static] [read-only]
The singleton instance of the Storage class. | FirebaseStorage | ||
version : String [read-only]
The version of this extension. | FirebaseStorage |
Method | Defined By | ||
---|---|---|---|
Constructor
You should not call this directly, but instead use the singleton access
| FirebaseStorage | ||
dispose():void
Disposes the extension and releases any allocated resources. | FirebaseStorage | ||
getMaxDownloadRetryTime():int | FirebaseStorage | ||
getMaxOperationRetryTime():int | FirebaseStorage | ||
getMaxUploadRetryTime():int | FirebaseStorage | ||
getReference(location:String = null):StorageReference
Creates a new StorageReference initialized with a child Firebase Storage location. | FirebaseStorage | ||
getReferenceFromUrl(fullUrl:String):StorageReference
Creates a StorageReference given a gs:// or //
URL pointing to a Firebase Storage location. | FirebaseStorage | ||
init(key:String):void Deprecated: You no longer need to call this function or use an application key [static]
Initialises the extension class for use with the provided key. | FirebaseStorage | ||
setMaxDownloadRetryTime(milliseconds:int):void | FirebaseStorage | ||
setMaxOperationRetryTime(milliseconds:int):void | FirebaseStorage | ||
setMaxUploadRetryTime(milliseconds:int):void | FirebaseStorage |
Constant | Defined By | ||
---|---|---|---|
EXT_CONTEXT_ID : String = com.distriqt.firebase.Storage [static] | FirebaseStorage | ||
VERSION : String = 10.1.0 [static] | FirebaseStorage |
implementation | property |
implementation:String
[read-only]
The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:
Android
iOS
default
unknown
public function get implementation():String
isSupported | property |
isSupported:Boolean
[read-only] Whether the current device supports the extensions functionality
public static function get isSupported():Boolean
nativeVersion | property |
nativeVersion:String
[read-only]
The native version string of the native extension.
public function get nativeVersion():String
service | property |
service:FirebaseStorage
[read-only] The singleton instance of the Storage class.
public static function get service():FirebaseStorage
Error — If there was a problem creating or accessing the extension, or if the key is invalid
|
version | property |
version:String
[read-only]
The version of this extension.
This should be of the format, MAJOR.MINOR.BUILD
public function get version():String
FirebaseStorage | () | Constructor |
public function FirebaseStorage()
Constructor You should not call this directly, but instead use the singleton access
dispose | () | method |
public function dispose():void
Disposes the extension and releases any allocated resources. Once this function
has been called, a call to init
is neccesary again before any of the
extensions functionality will work.
getMaxDownloadRetryTime | () | method |
public function getMaxDownloadRetryTime():int
Returnsint |
getMaxOperationRetryTime | () | method |
public function getMaxOperationRetryTime():int
Returnsint |
getMaxUploadRetryTime | () | method |
public function getMaxUploadRetryTime():int
Returnsint |
getReference | () | method |
public function getReference(location:String = null):StorageReference
Creates a new StorageReference initialized with a child Firebase Storage location.
If location is null
the root Firebase Storage location will be returned
Parameters
location:String (default = null ) — A relative path from the root to initialize the reference with,
for instance "path/to/object"
|
StorageReference — A StorageReference for the specified location
|
getReferenceFromUrl | () | method |
public function getReferenceFromUrl(fullUrl:String):StorageReference
Creates a StorageReference given a gs://
or //
URL pointing to a Firebase Storage location.
Parameters
fullUrl:String — A gs:// or http[s]:// URL
used to initialize the reference
|
StorageReference — A StorageReference for the specified url
|
init | () | method |
public static function init(key:String):void
Initialises the extension class for use with the provided key.
Parameters
key:String |
Error — If there was a problem creating or accessing the extension, or if the key is invalid
|
setMaxDownloadRetryTime | () | method |
public function setMaxDownloadRetryTime(milliseconds:int):void
Parameters
milliseconds:int |
setMaxOperationRetryTime | () | method |
public function setMaxOperationRetryTime(milliseconds:int):void
Parameters
milliseconds:int |
setMaxUploadRetryTime | () | method |
public function setMaxUploadRetryTime(milliseconds:int):void
Parameters
milliseconds:int |
EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.firebase.Storage
VERSION | Constant |
public static const VERSION:String = 10.1.0