Getting Started

설치

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

import

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 및 비상 사태 보고서와 관련된 사용자 정의 키와 값을 설정합니다.

Android 및 iOS에서만 사용 가능합니다.

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

사용자 ID(식별자)를 설정하여 이후의 fatal 및 비상 사태 보고서와 관련합니다.

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의 부분 집합이 stacktrace.js에 의해 생성됩니다.

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

진실의 근원

이 페이지는 플러그인의 src/definitions.ts공개 API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

Capgo를 사용 중이시면 Getting Started 대시보드와 Capgo를 계획하고 API 연산을 연결하세요. API Overview API 구현 세부 정보에 대한 개요에 대해 소개 __CAPGO_KEEP_0__ 키에 대한 구현 세부 정보에 대해 API 키 API 구현 세부 정보에 대한 장치에 대해 __CAPGO_KEEP_0__ 구현 세부 정보에 대한 패키지에 대해 __CAPGO_KEEP_0__ 구현 세부 정보에 대한 번들에 대해 __CAPGO_KEEP_0__ 편집 페이지 __CAPGO_KEEP_0__ 이전