Getting Started

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-crashlytics` plugin in my project.

如果您prefer手动设置，安装插件并运行以下命令并遵循以下平台特定说明：

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

导入

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

API概述

crash

崩溃测试实现，仅适用于Android和iOS。

复制到剪贴板

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

设置一个自定义的键和值，关联于随后的致命和非致命报告中。

仅适用于 Android 和 iOS。

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

设置一个用户 ID（标识符），关联于随后的致命和非致命报告中。

仅适用于 Android 和 iOS。

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

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

添加一个自定义的日志消息，发送与崩溃数据一起，给自己更多上下文，了解导致崩溃的事件。

仅适用于 Android 和 iOS。

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

await FirebaseCrashlytics.log({} as LogOptions);

setEnabled

__CAPGO_KEEP_0__（开/关）自动数据收集。 值在下一次应用程序运行时才生效。

__CAPGO_KEEP_0__仅适用于Android和iOS。

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

await FirebaseCrashlytics.setEnabled({} as SetEnabledOptions);

isEnabled

__CAPGO_KEEP_0__是否启用了自动数据收集。

__CAPGO_KEEP_0__仅适用于iOS。

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

__CAPGO_KEEP_0__是否在上一次执行中崩溃。

__CAPGO_KEEP_0__仅适用于Android和iOS。

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

await FirebaseCrashlytics.didCrashOnPreviousExecution();

sendUnsentReports

__CAPGO_KEEP_0__在下一次启动时将任何未发送的报告上传到Crashlytics中。

当自动数据收集功能启用时，Crashlytics会在启动时自动上传报告。

仅适用于Android和iOS。

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

__CAPGO_KEEP_0__将设备上的任何未发送的报告删除。

仅适用于Android和iOS。

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

__CAPGO_KEEP_0__将异常报告发送到Crashlytics。

仅适用于Android和iOS。

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

类型参考

CrashOptions

export interface CrashOptions {
  /**
   * @since 0.1.0
   */
  message: string;
}

SetCustomKeyOptions

export type SetCustomKeyOptions = CustomKeyAndValue;

SetUserIdOptions

export interface SetUserIdOptions {
  /**
   * @since 0.1.0
   */
  userId: string;
}

LogOptions

export interface LogOptions {
  /**
   * @since 0.1.0
   */
  message: string;
}

SetEnabledOptions

export interface SetEnabledOptions {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

IsEnabledResult

export interface IsEnabledResult {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

DidCrashOnPreviousExecutionResult

export interface DidCrashOnPreviousExecutionResult {
  /**
   * @since 0.1.0
   */
  crashed: boolean;
}

RecordExceptionOptions

export interface RecordExceptionOptions {
  /**
   * The message to record as a non-fatal exception.
   *
   * @since 0.1.0
   */
  message: string;
  /**
   * Error code within a specific error domain.
   *
   * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
   *
   * Only available for iOS.
   *
   * @since 0.1.0
   */
  code?: number;
  /**
   * A string containing the error domain.
   *
   * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
   *
   * Only available for iOS.
   *
   * @since 0.1.0
   */
  domain?: string;
  /**
   * An array of keys and the values to associate with the non fatal exception,
   * in addition to the app level custom keys.
   *
   * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
   *
   * @since 7.1.0
   */
  keysAndValues?: CustomKeyAndValue[];
  /**
   * A stacktrace generated by stacktrace.js.
   *
   * @since 1.1.0
   */
  stacktrace?: StackFrame[];
}

GetPluginVersionResult

export interface GetPluginVersionResult {
  /**
   * The semantic version of this plugin.
   *
   * @since 8.0.2
   */
  version: string;
}

CustomKeyAndValue

export interface CustomKeyAndValue {
  /**
   * @since 7.1.0
   */
  key: string;
  /**
   * @since 7.1.0
   */
  value: string | number | boolean;
  /**
   * @since 7.1.0
   */
  type: 'string' | 'long' | 'double' | 'boolean' | 'int' | 'float';
}

StackFrame

堆栈跟踪（由 stacktrace.js 生成）

export interface StackFrame {
  lineNumber?: number;
  fileName?: string;
  functionName?: string;
}

真实数据来源

本页由插件生成 src/definitions.ts当公共 API 上游发生变化时，请重新同步。

继续从开始

如果您正在使用 开始 为计划仪表板和 API 操作连接它 API 概述 查看 API 概述中的实现细节 简介 简介中的实现细节 API Keys API Keys中的实现细节 设备 设备中的实现细节 捆绑包 捆绑包中的实现细节