Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-persistent-uuid`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/persistent-uuid/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installer

npm install @capgo/capacitor-persistent-uuid
npx cap sync

Importer

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

Lire ou créer l'UUID

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

const result = await PersistentUuid.getId();

console.log(result.id);
console.log(result.scope);
console.log(result.created);

La première fois, cela crée et stocke un UUID. Les appels ultérieurs retournent le même UUID pour le même champ d'application.

Utiliser un champ d'application stable personnalisé

The scope par défaut natif est le nom de package sur Android et l'identifiant de bundle sur iOS. Si les builds de débogage et de production utilisent des identifiants de package différents mais devraient partager une UUID, passez un scope partagé.

const result = await PersistentUuid.getId({
  scope: 'com.example.app',
});

Réinitialiser l'UUID

Appelez resetId lorsque l'utilisateur se déconnecte, demande une réinitialisation de la vie privée, ou lorsque les tests automatisés ont besoin d'un nouvel identifiant.

const replacement = await PersistentUuid.resetId();
console.log(replacement.id);

Attentes de persistance

Android peut survivre à l'annulation et à la réinstallation, y compris Android Studio et les installations Play avec des clés de signature différentes, lorsque le nom de package ou le scope personnalisé est stable.
iOS survit aux mises à jour d'applications et aux mises à jour iOS tandis que les règles d'accès au Keychain restent les mêmes.
Web utilise localStorage et n'est qu'un fallback de développement.

Continuez de Getting Started

Si vous utilisez Démarrage pour ajouter une identité d'application persistante, connectez-la avec @capgo/capacitor-persistent-uuid pour l'aperçu, Comportement Android pour le comportement de réinstallation, Comportement iOS pour le comportement de la clé de chaîne, En utilisant @capgo/capacitor-persistent-uuid pour le tutoriel, et Répertoire du plugin Capgo pour d'autres plugins natifs.