API
API
Lua

Defold Learn logo


firebase

Version: stable

FUNCTIONS
firebase.crashlytics.initialize()
firebase.crashlytics.set_enabled()
firebase.crashlytics.is_enabled()
firebase.crashlytics.did_crash_on_previous_execution()
firebase.crashlytics.send_unsent_reports()
firebase.crashlytics.delete_unsent_reports()
firebase.crashlytics.set_user_id()
firebase.crashlytics.set_custom_key()
firebase.crashlytics.log()
firebase.crashlytics.record_exception()
firebase.crashlytics.record_lua_error()
firebase.crashlytics.test_java_crash()
firebase.crashlytics.test_native_crash()

Functions

firebase.crashlytics.initialize()

firebase.crashlytics.initialize()

Initializes Crashlytics and returns true if the core Firebase extension is available and the default FirebaseApp has been initialized.

PARAMETERS

None

RETURNS

boolean True if Crashlytics was initialized.

firebase.crashlytics.set_enabled()

firebase.crashlytics.set_enabled(enabled)

Sets whether Crashlytics collection is enabled for this app on this device.

PARAMETERS

enabled boolean
True to enable Crashlytics collection.

firebase.crashlytics.is_enabled()

firebase.crashlytics.is_enabled()

Returns whether Crashlytics collection is enabled.

PARAMETERS

None

RETURNS

boolean True if Crashlytics collection is enabled.

firebase.crashlytics.did_crash_on_previous_execution()

firebase.crashlytics.did_crash_on_previous_execution()

Returns whether the app crashed during the previous execution.

PARAMETERS

None

RETURNS

boolean True if a crash was recorded during the previous execution.

firebase.crashlytics.send_unsent_reports()

firebase.crashlytics.send_unsent_reports()

Sends queued crash reports when automatic collection is disabled.

PARAMETERS

None


firebase.crashlytics.delete_unsent_reports()

firebase.crashlytics.delete_unsent_reports()

Deletes queued crash reports when automatic collection is disabled.

PARAMETERS

None


firebase.crashlytics.set_user_id()

firebase.crashlytics.set_user_id(user_id)

Sets the user ID associated with subsequent fatal, non-fatal, and ANR reports.

PARAMETERS

user_id string
User identifier.

firebase.crashlytics.set_custom_key()

firebase.crashlytics.set_custom_key(key,value)

Sets a string, number, or boolean custom key for subsequent fatal, non-fatal, and ANR reports.

PARAMETERS

key string
Custom key name.
value string
number
boolean
String, number, or boolean value.

firebase.crashlytics.log()

firebase.crashlytics.log(message)

Logs a message that is included in the next fatal, non-fatal, or ANR report.

PARAMETERS

message string
Log message.

firebase.crashlytics.record_exception()

firebase.crashlytics.record_exception(message)

Records a non-fatal exception with the supplied message.

PARAMETERS

message string
Exception message.

firebase.crashlytics.record_lua_error()

firebase.crashlytics.record_lua_error(message,traceback)

Records a Lua runtime error as a non-fatal exception with parsed Lua stack frames when a traceback is supplied.

PARAMETERS

message string
Lua error message.
traceback string
nil
Lua traceback string, typically supplied by sys.set_error_handler. May be nil or omitted.

firebase.crashlytics.test_java_crash()

firebase.crashlytics.test_java_crash()

Forces a Java crash for Crashlytics setup testing. Android only.

PARAMETERS

None


firebase.crashlytics.test_native_crash()

firebase.crashlytics.test_native_crash()

Forces a native crash for Crashlytics setup testing.

PARAMETERS

None