Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complet 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.

Installation

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-persistent-uuid` 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 :

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 appel crée et stocke un UUID. Les appels ultérieurs retournent le même UUID pour le même champ.

Utiliser Un Champ Custom Stable

Le champ par défaut natif est le nom de package sur Android et l'identifiant de l'application sur iOS. Si les builds de débogage et de production utilisent des identifiants de package différents mais devraient partager un UUID, passez un champ 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 nécessitent un nouveau identifiant.

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

Attentes de persistance

L'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 l'étendue personnalisée est stable.
L'iOS survit aux mises à jour d'applications et aux mises à jour iOS tout en maintenant les mêmes règles d'accès à la clé de cache.
Le Web utilise localStorage et n'est qu'un fallback de développement.

Continuez de la section « Début de l'installation »

Si vous utilisez « Début de l'installation » pour ajouter une identité d'application persistante, connectez-la à @capgo/capacitor-uuid-persistent pour une vue d'ensemble comportement Android pour le comportement de réinstallation comportement iOS pour le comportement de la clé de chaîne En utilisant @capgo/capacitor-uuid-persistent pour le tutoriel, et Capgo Répertoire de plugins pour d'autres plugins natifs