Packagecom.myflashlab.air.extensions.firebase.crash
Classpublic class Crashlytics
InheritanceCrashlytics Inheritance Object

Handles configuration and initialization of Crashlytics.



Public Properties
 PropertyDefined By
  userEmail : String
[static] [write-only] Specify a user email which will be visible in the Crashlytics UI.
Crashlytics
  userIdentifier : String
[static] [write-only] Specify a user identifier which will be visible in the Crashlytics UI.
Crashlytics
  username : String
[static] [write-only] Specify a user name which will be visible in the Crashlytics UI.
Crashlytics
Public Methods
 MethodDefined By
  
crash():void
[static] The easiest way to cause a crash - great for testing!
Crashlytics
  
init($debugMode:Boolean = false):void
[static] Initializes Crashlytics in your app.
Crashlytics
  
log($key:String, $value:*):void
[static] Set a value for a key to be associated with your crash data which will be visible in the Crashlytics UI.
Crashlytics
Public Constants
 ConstantDefined By
  ANDROID_SDK : String = 2.10.1
[static]
Crashlytics
  EXTENSION_ID : String = com.myflashlab.air.extensions.firebase.crashlytics
[static]
Crashlytics
  IOS_SDK : String = 3.14.0
[static]
Crashlytics
  VERSION : String = 9.9.0
[static]
Crashlytics
Property Detail
userEmailproperty
userEmail:String  [write-only]

Specify a user email which will be visible in the Crashlytics UI. Please be mindful of your end-user's privacy and see if userIdentifier property can fulfil your needs.


Implementation
    public static function set userEmail(value:String):void
userIdentifierproperty 
userIdentifier:String  [write-only]

Specify a user identifier which will be visible in the Crashlytics UI. Many of our customers have requested the ability to tie crashes to specific end-users of their application in order to facilitate responses to support requests or permit the ability to reach out for more information. We allow you to specify up to three separate values for display within the Crashlytics UI - but please be mindful of your end-user's privacy. We recommend specifying a user identifier - an arbitrary string that ties an end-user to a record in your system. This could be a database id, hash, or other value that is meaningless to a third-party observer but can be indexed and queried by you. Optionally, you may also specify the end-user's name or username, as well as email address if you do not have a system that works well with obscured identifiers. Pursuant to our EULA, this data is transferred securely throughout our system and we will not disseminate end-user data unless required to by law. That said, if you choose to provide end-user contact information, we strongly recommend that you disclose this in your application's privacy policy. Data privacy is of our utmost concern.

If you ever need to clear a user identifier after you set it, reset the value to a blank string or null.


Implementation
    public static function set userIdentifier(value:String):void
usernameproperty 
username:String  [write-only]

Specify a user name which will be visible in the Crashlytics UI. Please be mindful of your end-user's privacy and see if userIdentifier property can fulfil your needs.


Implementation
    public static function set username(value:String):void
Method Detail
crash()method
public static function crash():void

The easiest way to cause a crash - great for testing!

init()method 
public static function init($debugMode:Boolean = false):void

Initializes Crashlytics in your app. You can call this method late in your app for example when user is logged in. What you must remember is to initialize Crashlytics AFTER you have successfully initialized the Firebase Core ANE.

Once Crashlytics is started, it can't be stopped or changed.

Parameters

$debugMode:Boolean (default = false) — default value is false. set it to true optionally when developing your app.

log()method 
public static function log($key:String, $value:*):void

Set a value for a key to be associated with your crash data which will be visible in the Crashlytics UI.

The value should be of type String, int, Number or Boolean.

Parameters

$key:String
 
$value:*

Constant Detail
ANDROID_SDKConstant
public static const ANDROID_SDK:String = 2.10.1

EXTENSION_IDConstant 
public static const EXTENSION_ID:String = com.myflashlab.air.extensions.firebase.crashlytics

IOS_SDKConstant 
public static const IOS_SDK:String = 3.14.0

VERSIONConstant 
public static const VERSION:String = 9.9.0