Firebase Crashlytics Capacitor 插件

使用 @capgo/capacitor-firebase-crashlytics

用于 Firebase Crashlytics 的 Capacitor 插件

安装

bun add @capgo/capacitor-firebase-crashlytics
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

API 概览

方法	描述
crash	强制触发崩溃以测试实现效果。
setCustomKey	设置与后续 fatal 和 non-fatal 报告关联的自定义键值对。
setUserId	设置与后续 fatal 和 non-fatal 报告关联的用户 ID（标识符）。
log	添加自定义日志消息并随崩溃数据一同发送，以便为崩溃前的事件提供更多上下文信息。
setEnabled	启用/禁用自动数据收集。该设置在下次启动 App 时生效。
isEnabled	返回是否已启用自动数据收集。
didCrashOnPreviousExecution	返回 App 在上次运行时是否发生过崩溃。
sendUnsentReports	在下次启动时将所有未发送的报告上传至 Crashlytics。
deleteUnsentReports	删除设备上所有未发送的报告。
recordException	记录一条非致命报告，以便发送到 Crashlytics。

示例

crash()

强制触发崩溃以测试实现效果。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.crash({ message: 'Hello from Capacitor' });

setCustomKey()

设置与后续 fatal 和 non-fatal 报告关联的自定义键值对。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.setCustomKey({
  key: 'key-123',
  value: 'value',
  type: 'string',
});

setUserId()

设置与后续 fatal 和 non-fatal 报告关联的用户 ID（标识符）。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.setUserId({ userId: 'user-id-123' });

log()

添加自定义日志消息并随崩溃数据一同发送，以便为崩溃前的事件提供更多上下文信息。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.log({ message: 'Hello from Capacitor' });

setEnabled()

启用/禁用自动数据收集。该设置在下次启动 App 时生效。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.setEnabled({ enabled: true });

isEnabled()

返回是否已启用自动数据收集。

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

const result = await FirebaseCrashlytics.isEnabled();
console.log(result);

上表列出了 10 个核心方法。监听器、版本辅助函数以及每个方法的完整接口定义，请参阅 GitHub 仓库.

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

从“使用 @capgo/capacitor-firebase-crashlytics”继续

如果你正在使用 使用 @capgo/capacitor-firebase-crashlytics 要规划原生插件工作，请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 查看添加或更新插件中的实现细节， Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流，以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。