Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-persistent-uuid
bunx cap sync

Démarrage rapide

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

const result = await PersistentUuid.getId();
console.log(result);

Exemple : resetId

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

const result = await PersistentUuid.resetId();
console.log(result);

Erreurs courantes

• Sync native : exécuter bunx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

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);

Le premier appel crée et stocke un UUID. Les appels suivants renvoient le même UUID pour le même scope.

Utiliser un scope personnalisé stable

Le scope natif par défaut est le nom du package sur Android et l'identifiant du bundle sur iOS. Si vos builds de debug et de production utilisent des identifiants de package différents mais doivent partager le même UUID, passez un scope partagé.

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

Réinitialiser l'UUID

Call resetId when the user logs out, requests a privacy reset, or when automated tests need a new identifier.

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

Attentes de persistance

• Sur Android, l'identifiant peut survivre à une désinstallation et une réinstallation, y compris les installations via Android Studio ou le Play Store avec des clés de signature différentes, si le nom du package ou le scope personnalisé est stable.
• iOS survit aux mises à jour de l'app et du système iOS, tant que les règles d'accès au Keychain restent inchangées.
• Web uses localStorage and is only a development fallback.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour ajouter une identité d'application persistante, connectez-l’à @capgo/capacitor-persistent-uuid pour l'aperçu, Comportement Android pour le comportement lors d'une réinstallation, Comportement iOS pour le comportement du Keychain, En utilisant @capgo/capacitor-persistent-uuid pour le tutoriel, et Capgo Répertoire des plugins pour les autres plugins natifs.