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

Setzt eine benutzerdefinierte Schlüssel-Wert-Kombination, die mit fatalen und nicht-fatalen Berichten verbunden ist.

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 (Identifier), die mit 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 einen benutzerdefinierten Log-Nachricht hinzu, die mit Ihren Crash-Daten gesendet wird, um sich mehr Kontext für die Ereignisse zu verschaffen, die zu einem Crash 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 Datenverarbeitung aktivieren/deaktivieren. 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

Ermittelt, ob die automatische Datenverarbeitung aktiviert ist.

Nur für iOS verfügbar.

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

Ermittelt, 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

Uploads alle unbeauftragten Berichte bei der nächsten Startzeit zu Crashlytics.

Wenn die automatische Datenverteilung aktiviert ist, lädt Crashlytics die Berichte bei der Startzeit automatisch hoch.

Nur für Android und iOS verfügbar.

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

Löscht alle unbeauftragten 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 zu 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

Teil des Stapelverfolgungsberichts, der durch stacktrace.js generiert wird.

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

Quellwahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsWenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisierung erneut durch.

Fortsetzen von Getting Started

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