react-native-firebase / crashlytics/lib/modular
crashlytics/lib/modular
checkForUnsentReports()
checkForUnsentReports(
crashlytics):Promise<boolean>
Defined in: crashlytics/lib/modular.ts:34
Determines whether there are any unsent crash reports cached on the device. The callback only executes if automatic data collection is disabled.
Example
async checkReports() {
// returns boolean value
const crashlytics = getCrashlytics();
const unsentReports = await checkForUnsentReports(crashlytics);
}
checkReports();
crash()
crash(
crashlytics):void
Defined in: crashlytics/lib/modular.ts:91
Cause your app to crash for testing purposes. This is a native crash and will not contain a javascript stack trace. Note that crashes are intercepted by debuggers on iOS so no report will be seen under those conditions. Additionally if it is a debug build you will need to ensure your firebase.json is configured to enable crashlytics even in debug mode.
deleteUnsentReports()
deleteUnsentReports(
crashlytics):Promise<void>
Defined in: crashlytics/lib/modular.ts:51
Deletes any unsent reports on the device. This method only applies if automatic data collection is disabled.
didCrashOnPreviousExecution()
didCrashOnPreviousExecution(
crashlytics):Promise<boolean>
Defined in: crashlytics/lib/modular.ts:73
Returns a boolean value indicating whether the app crashed during the previous execution.
Example
async didCrashPreviously() {
// returns boolean value
const crashlytics = getCrashlytics();
const didCrash = await didCrashOnPreviousExecution(crashlytics);
}
didCrashPreviously();
Returns
Promise<boolean>
Promise that resolves to a boolean indicating if the app crashed previously.
getCrashlytics()
getCrashlytics():
Crashlytics
Defined in: crashlytics/lib/modular.ts:12
Returns Crashlytics instance.
log()
log(
crashlytics,message):void
Defined in: crashlytics/lib/modular.ts:109
Log a message that will appear in any subsequent Crash or Non-fatal error reports.
Example
const crashlytics = getCrashlytics();
log(crashlytics, 'Testing a crash');
crash(crashlytics);
recordError()
recordError(
crashlytics,error,jsErrorName?):void
Defined in: crashlytics/lib/modular.ts:134
Record a JavaScript Error.
The JavaScript stack trace is converted into a mock native iOS or Android exception before submission. The line numbers in the stack trace (if available) will be relative to the javascript bundle built by your packager, after whatever transpilation or minimization steps happen. You will need to maintain sourcemaps to decode them if desired.
Example
const crashlytics = getCrashlytics();
recordError(
crashlytics,
new Error('An error was caught')
);
sendUnsentReports()
sendUnsentReports(
crashlytics):void
Defined in: crashlytics/lib/modular.ts:151
Enqueues any unsent reports on the device to upload to Crashlytics. This method only applies if automatic data collection is disabled.
setAttribute()
setAttribute(
crashlytics,name,value):Promise<null>
Defined in: crashlytics/lib/modular.ts:196
Sets a string value to be associated with the given attribute name which will be visible in the Firebase Crashlytics console.
setAttributes()
setAttributes(
crashlytics,attributes):Promise<null>
Defined in: crashlytics/lib/modular.ts:216
Like setAttribute but for multiple attributes.
Example
const crashlytics = getCrashlytics();
await setAttributes(crashlytics, {
role: 'admin',
followers: '13',
});
setCrashlyticsCollectionEnabled()
setCrashlyticsCollectionEnabled(
crashlytics,enabled):Promise<null>
Defined in: crashlytics/lib/modular.ts:239
Enable/disable Crashlytics reporting.
Use this for opt-in first user data collection flows combined with firebase.json settings to disable auto collection.
Example
const crashlytics = getCrashlytics();
// Disable crash reporting
await setCrashlyticsCollectionEnabled(crashlytics, false);
setUserId()
setUserId(
crashlytics,userId):Promise<null>
Defined in: crashlytics/lib/modular.ts:178
Specify a user identifier which will be visible in the Firebase Crashlytics console.
It is recommended for privacy purposes that this value be a value that's meaningless to a third-party observer; such as an arbitrary string that ties an end-user to a record in your system e.g. a database record id.
Example
const auth = getAuth();
const crashlytics = getCrashlytics();
// Custom user id
await setUserId(crashlytics, '123456789');
// Firebase auth uid
await setUserId(
crashlytics,
auth.currentUser.uid
);