はじめに

インストール

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

インポート

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

API の概要

crash

__CAPGO_KEEP_0__ を使用してクラッシュを強制します。実装をテストするには、クラッシュを強制します。

Android と iOS のみ

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

__CAPGO_KEEP_0__ を設定すると、fatal および non-fatal 報告に連携するカスタムキーと値が設定されます。

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

自動データ収集を有効/無効にします。値は、次のアプリの実行まで適用されません。

AndroidおよびiOSのみ

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

await FirebaseCrashlytics.setEnabled({} as SetEnabledOptions);

isEnabled

自動データ収集が有効かどうかを返します。

iOSのみで利用可能です。

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

前回の実行時、エラーが発生したかどうかを返します。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseCrashlytics.didCrashOnPreviousExecution();

sendUnsentReports

起動時にCrashlyticsに未送信のレポートをアップロードします。

自動データ収集が有効の場合、起動時にCrashlyticsがレポートを自動的にアップロードします。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

デバイス上の未送信レポートをすべて削除します。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

非致死的なレポートを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.tspublic API がアップストリームで変更された場合に、再度同期を実行してください。