Getting Started

インストール

Capgo の AI 助成インストール機能を使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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.

Manual Setup を使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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__を有効/無効にします。 値は、次のアプリの実行まで適用されません。

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

__CAPGO_KEEP_0__をCrashlyticsにアップロードします。

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

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);

Type Reference

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

__CAPGO_KEEP_0__

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

真実の源

このページはプラグインの src/definitions.tsパブリック API がアップストリームで変更された場合に再度同期を実行してください。

「Getting Started」から続けてください

ダッシュボードと __CAPGO_KEEP_0__ の作業を計画するには __CAPGO_KEEP_0__ オーバーウィュー API オーバーウィューの実装詳細については 「API オーバーウィュー」を参照してください 「API オーバーウィュー」 導入 導入の実装詳細について API キー API キーの実装詳細について デバイス デバイスの実装詳細について バンドル バンドルの実装詳細について