| Package | com.tuarua.firebase |
| Class | public final class Firestore |
| Inheritance | Firestore  flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| loggingEnabled : Boolean [static] Whether logging from the Firestore client is enabled/disabled. | Firestore | ||
| settings : FirestoreSettings [static] | Firestore | ||
| Method | Defined By | ||
|---|---|---|---|
| Firestore | |||
collection(collectionPath:String):CollectionReference | Firestore | ||
disableNetwork(listener:Function = null):void
Disables usage of the network by this Firestore instance. | Firestore | ||
dispose():void [static] Disposes the ANE | Firestore | ||
document(documentPath:String = null):DocumentReference | Firestore | ||
enableNetwork(listener:Function = null):void
Re-enables usage of the network by this Firestore instance after a prior call to
disableNetwork. | Firestore | ||
| loggingEnabled | property |
loggingEnabled:BooleanWhether logging from the Firestore client is enabled/disabled.
public static function get loggingEnabled():Boolean public static function set loggingEnabled(value:Boolean):void| settings | property |
settings:FirestoreSettings public static function get settings():FirestoreSettings public static function set settings(value:FirestoreSettings):void| batch | () | method |
| collection | () | method |
public function collection(collectionPath:String):CollectionReferenceParameters
collectionPath:String |
CollectionReference |
| disableNetwork | () | method |
public function disableNetwork(listener:Function = null):void
Disables usage of the network by this Firestore instance. It can be re-enabled by via
enableNetwork. While the network is disabled, any snapshot listeners or get calls
will return results from cache and any write operations will be queued until the network is
restored.
Parameters
listener:Function (default = null)
function callback(error:FirestoreError):void {
}
|
| dispose | () | method |
public static function dispose():voidDisposes the ANE
| document | () | method |
public function document(documentPath:String = null):DocumentReferenceParameters
documentPath:String (default = null) |
DocumentReference |
| enableNetwork | () | method |
public function enableNetwork(listener:Function = null):void
Re-enables usage of the network by this Firestore instance after a prior call to
disableNetwork.
Parameters
listener:Function (default = null)
function callback(error:FirestoreError):void {
}
|