Inizia con Getting Started

Installazione

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

Importazione

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

API Panoramica

crash

Forza un crash per testare l'implementazione.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

Imposta una chiave e un valore personalizzati associati a eventuali rapporti fatali e non fatali.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

Imposta un ID utente (identificatore) associato a eventuali rapporti fatali e non fatali.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

Aggiunge un messaggio di log personalizzato che viene inviato con i dati di crash per fornire più contesto per gli eventi che portano a un crash.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.log({} as LogOptions);

setEnabled

Abilita/disabilita la raccolta automatica dei dati. Il valore non si applica fino alla prossima esecuzione dell'app.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.setEnabled({} as SetEnabledOptions);

isEnabled

Restituisce se la raccolta automatica dei dati è abilitata o meno.

Disponibile solo per iOS.

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

Restituisce se l'applicazione si è bloccata durante l'esecuzione precedente.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.didCrashOnPreviousExecution();

sendUnsentReports

Carica eventuali rapporti non inviati a Crashlytics al prossimo avvio.

Quando l'acquisizione automatica dei dati è abilitata, Crashlytics carica automaticamente i rapporti all'avvio.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

Elimina eventuali rapporti non inviati sul dispositivo.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

Registra un rapporto non fatale da inviare a Crashlytics.

Disponibile solo per Android e iOS.

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

Riferimento di tipo

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

Sottosezione della traccia dell'errore generata da stacktrace.js.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando il pubblico API cambia upstream.

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e operazioni di API , connettilo con API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Keys per i dettagli di implementazione in API Keys, Dispositivi per i dettagli di implementazione in Dispositivi, e Pacchetti per il dettaglio di implementazione in Pacchetti.