始めて

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。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.

__CAPGO_KEEP_0__の手動セットアップを利用する場合は、以下のコマンドを実行してプラットフォーム固有の指示を参照してください:

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

fatalおよびnon-fatalレポートに関連付けられたカスタムキーと値を設定します。

AndroidおよびiOSのみ対応

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

fatalおよびnon-fatalレポートに関連付けられたユーザー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.tsパブリック API がアップストリームで変更された場合に再度同步を実行してください。

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

あなたが 「Getting Started」を使用してダッシュボードと __CAPGO_KEEP_0__ の操作を計画している場合、 「API Overview」 「API Overview」 APIの実装詳細についてはOverviewを参照してください。 Introduction __CAPGO_KEEP_0__のキーについてはIntroductionを参照してください。 API Keys API Keysの実装詳細についてはAPI Keysを参照してください。 Devices __CAPGO_KEEP_0__の実装詳細についてはDevicesを参照してください。 Bundles __CAPGO_KEEP_0__の実装詳細についてはBundlesを参照してください。