Einstieg

Installieren

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

Importieren

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

API Übersicht

crash

Zur Testung der Implementierung einen Crash erzwingt.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

Eine benutzerdefinierte Schlüssel-Wert-Paare setzt, die mit fatalen und nicht-fatalen Berichten verbunden sind.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

Setzt eine Benutzer-ID (Kennzeichner), die mit nachfolgenden fatalen und nicht-fatalen Berichten verbunden ist.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

Fügt eine benutzerdefinierte Protokollierungsnachricht hinzu, die mit Ihren Fehlerdaten gesendet wird, um Ihnen mehr Kontext für die Ereignisse zu geben, die zu einem Fehler führen.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.log({} as LogOptions);

setEnabled

Aktiviert/deaktiviert die automatische Datenerfassung. 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 Datenerfassung 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

Überträgt alle ungesendeten Berichte zu Crashlytics bei der nächsten Startphase.

Wenn die automatische Datenerfassung aktiviert ist, überträgt Crashlytics die Berichte automatisch bei der Startphase.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

Löscht alle nicht gesendeten Berichte auf dem Gerät.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

Führt einen nicht fatalen Bericht aus, um ihn an Crashlytics zu senden.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

Typenverweis

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 des Stacktraces, das von stacktrace.js generiert wird.

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

Abschnitt mit dem Titel „Quelle der Wahrheit“

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