Getting Started

Abschnitt mit dem Titel „Installieren“

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann die folgende Anleitung:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-crashlytics` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

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

Importieren

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

API Übersicht

crash

Zwingt einen Crash herbei, um die Implementierung zu testen.

Erstellt nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

Setzt einen benutzerdefinierten Schlüssel und Wert, der mit nachfolgenden fatalen und nicht-fatalen Berichten verbunden ist.

Erstellt nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

Setzt einen Benutzer-Id-Bezeichner, der mit nachfolgenden fatalen und nicht-fatalen Berichten verbunden ist.

Erstellt nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

Fügt einen benutzerdefinierten Protokoll-Eintrag hinzu, der mit Ihren Fehlerdaten gesendet wird, um Ihnen mehr Kontext für die Ereignisse zu geben, die zu einem Fehler geführt haben.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.log({} as LogOptions);

setEnabled

Automatische Datenverteilung aktiviert oder deaktiviert. Der Wert wird erst bei der nächsten App-Ausführung angewendet.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.setEnabled({} as SetEnabledOptions);

isEnabled

Gibt an, ob die automatische Datenverteilung aktiviert ist.

Nur für iOS verfügbar.

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

Gibt an, ob die App während der vorherigen Ausführung abstürzte.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.didCrashOnPreviousExecution();

sendUnsentReports

Jeder unbeauftragte Bericht wird bei der nächsten Startzeit hochgeladen.

Wenn die automatische Datenverteilung aktiviert ist, werden die Berichte bei der Startzeit automatisch hochgeladen.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

Löscht jeden unbeauftragten Bericht auf dem Gerät.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

Ein nicht-fataler Bericht wird zum Senden an Crashlytics aufgezeichnet.

Verfügbar nur für Android und iOS.

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

Typenreferenz

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

Untermenge der Stacktrace, die durch stacktrace.js generiert wird.

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

Quellwahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie Getting Started um das Planungsdashboard und die API-Operationen zu planen, verbinden Sie es mit API-Übersicht für die Implementierungsdetails in der API-Übersicht Einführung für die Implementierungsdetails in der Einführung API-Schlüssel für die Implementierungsdetails in den API-Schlüsseln Geräte für die Implementierungsdetails in Geräten und Bundles für die Implementierungsdetails in Bundles.