Accueil

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Aperçu

crash

Force un crash pour tester la mise en œuvre.

Disponible uniquement pour Android et iOS.

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

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

Définit une clé et une valeur personnalisées associées aux rapports mortels et non mortels ultérieurs.

Disponible uniquement pour Android et iOS.

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

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

Définit un ID d'utilisateur (identifiant) associé aux rapports mortels et non mortels ultérieurs.

Disponible uniquement pour Android et iOS.

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

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

Ajoute un message de journal personnalisé qui est envoyé avec vos données de crash pour vous donner plus de contexte sur les événements qui ont conduit à une panne.

Disponible uniquement pour Android et iOS.

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

await FirebaseCrashlytics.log({} as LogOptions);

setEnabled

Active/Desactive la collecte de données automatique. La valeur n'est pas appliquée jusqu'à la prochaine exécution de l'application.

Seulement disponible pour Android et iOS.

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

await FirebaseCrashlytics.setEnabled({} as SetEnabledOptions);

isEnabled

Renvoie si la collecte de données automatique est activée ou non.

Seulement disponible pour iOS.

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

await FirebaseCrashlytics.isEnabled();

didCrashOnPreviousExecution

Renvoie si l'application a planté lors de l'exécution précédente.

Seulement disponible pour Android et iOS.

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

await FirebaseCrashlytics.didCrashOnPreviousExecution();

sendUnsentReports

Envoie tous les rapports non envoyés vers Crashlytics au prochain démarrage.

Lorsque la collecte de données automatique est activée, Crashlytics envoie automatiquement les rapports au démarrage.

Seulement disponible pour Android et iOS.

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

await FirebaseCrashlytics.sendUnsentReports();

deleteUnsentReports

Supprime tous les rapports non envoyés sur le dispositif.

Seulement disponible pour Android et iOS.

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

await FirebaseCrashlytics.deleteUnsentReports();

recordException

Enregistre un rapport non fatal pour l'envoi vers Crashlytics.

Seulement disponible pour Android et iOS.

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

await FirebaseCrashlytics.recordException({} as RecordExceptionOptions);

Référence de type

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

Sous-ensemble de la trace d'erreur générée par stacktrace.js.

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.

Continuez de l'étape de démarrage

Si vous utilisez Étape de démarrage pour planifier le tableau de bord et les opérations API, connectez-le avec API Overview pour les détails d'implémentation dans API Overview, Introduction Pour les détails d'implémentation dans l'Introduction, API Keys Pour les détails d'implémentation dans API Keys, Devices Pour les détails d'implémentation dans les Devices, et Bundles Pour les détails d'implémentation dans les Bundles.