Getting Started

설치

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.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래에 플랫폼에 따라 설명된 지침을 따르세요.

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

Import

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

API 개요

crash

__CAPGO_KEEP_1__은 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

자동 데이터 수집을 활성화/비활성화합니다. 앱이 다시 실행될 때까지 적용되지 않습니다.

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로 bất 정기 보고서를 업로드합니다.

__CAPGO_KEEP_0__ 자동 데이터 수집이 활성화된 경우 Crashlytics는 시작 시 보고서를 자동으로 업로드합니다.

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

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

__CAPGO_KEEP_0__ 기기에서 bất 정기 보고서를 삭제합니다.

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

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

__CAPGO_KEEP_0__ Crashlytics로 비정상적인 보고서를 전송하기 위해 기록합니다.

__CAPGO_KEEP_0__ 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

스택 트레이스

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

실질적 진원지

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

Getting Started에서 계속

__CAPGO_KEEP_0__을 사용하는 경우 Getting Started API를 계획하고 API 연산을 위해 연결하세요. API Overview API Overview에서 구현 세부 정보를 확인하세요. __CAPGO_KEEP_0__ Introduction API Keys API Keys implementation 세부 정보를 위한 __CAPGO_KEEP_0__ Keys 장치 implementation 세부 정보를 위한 장치 배포