| Package | com.distriqt.extension.firebase |
| Class | public final class Firebase |
| Inheritance | Firebase  flash.events.EventDispatcher |
This class represents the Firebase extension.
| Property | Defined By | ||
|---|---|---|---|
| analytics : FirebaseAnalytics [read-only]
Access to the core Firebase Analytics functionality. | Firebase | ||
| deepLinkURLScheme : String [write-only]
The URL scheme used to set up Durable Deep Link service
Note this may be overridden if you specify the deepLinkURLScheme
by custom options to the initialiseApp call. | Firebase | ||
| implementation : String [read-only]
The implementation currently in use. | Firebase | ||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| Firebase | ||
| nativeVersion : String [read-only]
The native version string of the native extension. | Firebase | ||
| service : Firebase [static] [read-only]
The singleton instance of the Firebase class. | Firebase | ||
| version : String [read-only]
The version of this extension. | Firebase | ||
| Method | Defined By | ||
|---|---|---|---|
Firebase()
Constructor
You should not call this directly, but instead use the singleton access
| Firebase | ||
dispose():void
Disposes the extension and releases any allocated resources. | Firebase | ||
Returns the current options in use by the Firebase application
| Firebase | ||
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. | Firebase | ||
initialiseApp(options:FirebaseOptions = null):Boolean
Initialises the Firebase application. | Firebase | ||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.Firebase [static] | Firebase | ||
| VERSION : String = 10.1.0 [static] | Firebase | ||
| analytics | property |
analytics:FirebaseAnalytics [read-only]
Access to the core Firebase Analytics functionality.
public function get analytics():FirebaseAnalytics| deepLinkURLScheme | property |
deepLinkURLScheme:String [write-only]
The URL scheme used to set up Durable Deep Link service
Note this may be overridden if you specify the deepLinkURLScheme
by custom options to the initialiseApp call.
public function set deepLinkURLScheme(value:String):void| 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:
AndroidiOSdefaultunknown 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:Firebase [read-only] The singleton instance of the Firebase class.
public static function get service():FirebaseError — 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| Firebase | () | Constructor |
public function Firebase()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.
| getOptions | () | method |
public function getOptions():FirebaseOptionsReturns the current options in use by the Firebase application
ReturnsFirebaseOptions — The current FirebaseOptions in use or null if the app hasn't been configured
|
| init | () | method |
public static function init(key:String):voidInitialises 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
|
| initialiseApp | () | method |
public function initialiseApp(options:FirebaseOptions = null):BooleanInitialises the Firebase application.
Parameters
options:FirebaseOptions (default = null) |
Boolean — true if the application was successfully configured from available options
|
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.Firebase| VERSION | Constant |
public static const VERSION:String = 10.1.0