| Package | com.myflashlab.air.extensions.firebase.db |
| Class | public class DB |
| Inheritance | DB  Object |
DB.init(). To access a location in the database and read or write data,
use DB.getReference().
| Property | Defined By | ||
|---|---|---|---|
| persistenceEnabled : Boolean [static] [write-only]
The Firebase Database client will cache synchronized data and keep track of all writes you've initiated while
your application is running. | DB | ||
| sdkVersion : String [static] [read-only]
The server version for this build of the Firebase Database client
| DB | ||
| Method | Defined By | ||
|---|---|---|---|
cleanAllReferences():void [static]
Call this method so the ANE can consider all db related instances for garbage collection. | DB | ||
getReference($path:String = null):DBReference [static]
Gets a new DBReference instance. | DB | ||
goOffline():void [static] Shuts down our connection to the Firebase Database backend until goOnline() is called. | DB | ||
goOnline():void [static] Resumes our connection to the Firebase Database backend after a previous goOffline() call. | DB | ||
init(url:String = null):void [static]
Call this method prior to any other DB methods. | DB | ||
purgeOutstandingWrites():void [static]
The Firebase Database client automatically queues writes and sends them to the server at the earliest
opportunity, depending on network connectivity. | DB | ||
| Constant | Defined By | ||
|---|---|---|---|
| EXTENSION_ID : String = com.myflashlab.air.extensions.firebase.realtimeDB [static] | DB | ||
| LOGGER_LEVEL_DEBUG : int = 1 [static] | DB | ||
| LOGGER_LEVEL_ERROR : int = 2 [static] | DB | ||
| LOGGER_LEVEL_INFO : int = 3 [static] | DB | ||
| LOGGER_LEVEL_NONE : int = 5 [static] | DB | ||
| LOGGER_LEVEL_WARN : int = 4 [static] | DB | ||
| VERSION : String = 9.9.0 [static] | DB | ||
| persistenceEnabled | property |
persistenceEnabled:Boolean [write-only] The Firebase Database client will cache synchronized data and keep track of all writes you've initiated while your application is running. It seamlessly handles intermittent network connections and re-sends write operations when the network connection is restored. However by default your write operations and cached data are only stored in-memory and will be lost when your app restarts. By setting this value to 'true', the data will be persisted to on-device (disk) storage and will thus be available again when the app is restarted (even when there is no network connectivity at that time). Note that this method must be called before creating your first Database reference and only needs to be called once per application.
public static function set persistenceEnabled(value:Boolean):void| sdkVersion | property |
sdkVersion:String [read-only] The server version for this build of the Firebase Database client
public static function get sdkVersion():String| cleanAllReferences | () | method |
public static function cleanAllReferences():voidCall this method so the ANE can consider all db related instances for garbage collection. You need to call this method from time to time to avoid too many empty references staying at your app with no use. However, remember to call this method ONLY when you don't have an active database operation in progress. Calling this method when your app is interacting with server will break your app. When you call this method, All database references and listeners will broke. You will need to create new references after this method is called.
| getReference | () | method |
public static function getReference($path:String = null):DBReference
Gets a new DBReference instance. Refrence for the provided path if you set the $path parameter.
Parameters
$path:String (default = null) |
DBReference — |
| goOffline | () | method |
public static function goOffline():voidShuts down our connection to the Firebase Database backend until goOnline() is called.
| goOnline | () | method |
public static function goOnline():voidResumes our connection to the Firebase Database backend after a previous goOffline() call.
| init | () | method |
public static function init(url:String = null):voidCall this method prior to any other DB methods.
Parameters
url:String (default = null) |
| purgeOutstandingWrites | () | method |
public static function purgeOutstandingWrites():voidThe Firebase Database client automatically queues writes and sends them to the server at the earliest opportunity, depending on network connectivity. In some cases (e.g. offline usage) there may be a large number of writes waiting to be sent. Calling this method will purge all outstanding writes so they are abandoned. All writes will be purged, including transactions and onDisconnect() writes. The writes will be rolled back locally, perhaps triggering events for affected event listeners, and the client will not (re-)send them to the Firebase backend.
| EXTENSION_ID | Constant |
public static const EXTENSION_ID:String = com.myflashlab.air.extensions.firebase.realtimeDB| LOGGER_LEVEL_DEBUG | Constant |
public static const LOGGER_LEVEL_DEBUG:int = 1| LOGGER_LEVEL_ERROR | Constant |
public static const LOGGER_LEVEL_ERROR:int = 2| LOGGER_LEVEL_INFO | Constant |
public static const LOGGER_LEVEL_INFO:int = 3| LOGGER_LEVEL_NONE | Constant |
public static const LOGGER_LEVEL_NONE:int = 5| LOGGER_LEVEL_WARN | Constant |
public static const LOGGER_LEVEL_WARN:int = 4| VERSION | Constant |
public static const VERSION:String = 9.9.0