| Package | com.distriqt.extension.firebase.crashlytics |
| Class | public final class FirebaseCrashlytics |
| Inheritance | FirebaseCrashlytics  flash.events.EventDispatcher |
This class represents the crashlytics extension.
| Property | Defined By | ||
|---|---|---|---|
| implementation : String [read-only]
The implementation currently in use. | FirebaseCrashlytics | ||
| isSupported : Boolean [static] [read-only]
Whether the current device supports the extensions functionality
| FirebaseCrashlytics | ||
| nativeVersion : String [read-only]
The native version string of the native extension. | FirebaseCrashlytics | ||
| service : FirebaseCrashlytics [static] [read-only]
The singleton instance of the Crashlytics class. | FirebaseCrashlytics | ||
| version : String [read-only]
The version of this extension. | FirebaseCrashlytics | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
You should not call this directly, but instead use the singleton access
| FirebaseCrashlytics | ||
didCrashOnPreviousExecution():Boolean | FirebaseCrashlytics | ||
dispose():void
Disposes the extension and releases any allocated resources. | FirebaseCrashlytics | ||
enableCollection(enable:Boolean = true):void | FirebaseCrashlytics | ||
forceCrash():void
Forces a crash of your application. | FirebaseCrashlytics | ||
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. | FirebaseCrashlytics | ||
log(message:String):void
Logs a message to Crashlytics. | FirebaseCrashlytics | ||
recordError(error:Error):void
Generates a crash report for the given error. | FirebaseCrashlytics | ||
setBooleanValue(value:Boolean, key:String):void
Set a Boolean custom key
Custom keys help you get the specific state of your app leading up to a crash. | FirebaseCrashlytics | ||
setDebug(enabled:Boolean):void Deprecated: No longer supported
This is no longer supported, you should use the standard Firebase debugging flags to enable
debug mode and logging. | FirebaseCrashlytics | ||
setIntValue(value:int, key:String):void
Set an integer custom key
Custom keys help you get the specific state of your app leading up to a crash. | FirebaseCrashlytics | ||
setNumericValue(value:Number, key:String):void
Set a numeric value custom key
Custom keys help you get the specific state of your app leading up to a crash. | FirebaseCrashlytics | ||
setStringValue(value:String, key:String):void
Set a String value custom key
Custom keys help you get the specific state of your app leading up to a crash. | FirebaseCrashlytics | ||
setUserIdentifier(identifier:String):void
Sets the current user identifier
To diagnose an issue, it’s often helpful to know which of your users experienced a given crash. | FirebaseCrashlytics | ||
| Constant | Defined By | ||
|---|---|---|---|
| EXT_CONTEXT_ID : String = com.distriqt.firebase.Crashlytics [static] | FirebaseCrashlytics | ||
| VERSION : String = 10.1.0 [static] | FirebaseCrashlytics | ||
| 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:FirebaseCrashlytics [read-only] The singleton instance of the Crashlytics class.
public static function get service():FirebaseCrashlyticsError — 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| FirebaseCrashlytics | () | Constructor |
public function FirebaseCrashlytics()Constructor You should not call this directly, but instead use the singleton access
| didCrashOnPreviousExecution | () | method |
public function didCrashOnPreviousExecution():BooleanReturns
Boolean — |
| 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.
| enableCollection | () | method |
public function enableCollection(enable:Boolean = true):void
Parameters
enable:Boolean (default = true) |
| forceCrash | () | method |
public function forceCrash():voidForces a crash of your application. Useful for testing the Crashlytics installation.
| 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
|
| log | () | method |
public function log(message:String):void
Logs a message to Crashlytics.
Crashlytics associates the logs with your crash data and makes them visible in the Firebase console.
To avoid slowing down your app, Crashlytics limits logs to 64kB. Crashlytics deletes older log entries if a session's logs go over that limit.
Parameters
message:String — The message string to log
|
| recordError | () | method |
public function recordError(error:Error):void
Generates a crash report for the given error. This method should be used for unexpected exceptions where recovery is not possible.
Parameters
error:Error — The error to report
|
| setBooleanValue | () | method |
public function setBooleanValue(value:Boolean, key:String):void
Set a Boolean custom key
Custom keys help you get the specific state of your app leading up to a crash.
Parameters
value:Boolean — The boolean value
| |
key:String — The identifying key
|
| setDebug | () | method |
public function setDebug(enabled:Boolean):void
This is no longer supported, you should use the standard Firebase debugging flags to enable
debug mode and logging.
Android enable logging through adb: adb shell setprop log.tag.FirebaseCrashlytics DEBUG
iOS use the -FIRDebugEnabled flag to launch your application.
Parameters
enabled:Boolean |
| setIntValue | () | method |
public function setIntValue(value:int, key:String):void
Set an integer custom key
Custom keys help you get the specific state of your app leading up to a crash.
Parameters
value:int — The integer value
| |
key:String — The identifying key
|
| setNumericValue | () | method |
public function setNumericValue(value:Number, key:String):void
Set a numeric value custom key
Custom keys help you get the specific state of your app leading up to a crash.
Parameters
value:Number — The Number value
| |
key:String — The identifying key
|
| setStringValue | () | method |
public function setStringValue(value:String, key:String):void
Set a String value custom key
Custom keys help you get the specific state of your app leading up to a crash.
Parameters
value:String — The String value
| |
key:String — The identifying key
|
| setUserIdentifier | () | method |
public function setUserIdentifier(identifier:String):void
Sets the current user identifier
To diagnose an issue, it’s often helpful to know which of your users experienced a given crash. Crashlytics includes a way to anonymously identify users in your crash reports.
If you need to clear the value supply an empty string as the parameter
(i,e, setUserIdentifier(""))
Parameters
identifier:String — The string identifier for the current user
|
| EXT_CONTEXT_ID | Constant |
public static const EXT_CONTEXT_ID:String = com.distriqt.firebase.Crashlytics| VERSION | Constant |
public static const VERSION:String = 10.1.0