시작하기

설치

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

설치 단계

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

API 개요

crash

사고 테스트를 위해 강제로 시스템을 종료합니다.

안드로이드와 iOS만 지원합니다.

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

사고 보고서에 사용할 고유 키와 값을 설정합니다.

안드로이드와 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

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

__CAPGO_KEEP_5__

__CAPGO_KEEP_6__

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

__CAPGO_KEEP_7__

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_2__

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

__CAPGO_KEEP_1__

이 페이지는 플러그인의 src/definitions.ts. Re-run the sync when the public API changes upstream.