Getting Started

GitHub

Eine Setup-Vorlage mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.

        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.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehlszeile hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

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

Importieren

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

Die UUID lesen oder erstellen

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

const result = await PersistentUuid.getId();

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

Die erste Anfrage erstellt und speichert eine UUID. Spätere Anfragen geben für denselben Bereich die gleiche UUID zurück.

Einen stabilen benutzerdefinierten Bereich verwenden

Der native Standardbereich ist der Paketname auf Android und der Bundle-Identifier auf iOS. Wenn Debug- und Produktionsbuilds unterschiedliche Paket-Identifikatoren verwenden, aber eine UUID teilen sollen, übergeben Sie einen gemeinsamen Bereich.

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

Die UUID zurücksetzen

Rufen Sie resetId, wenn der Benutzer sich abmeldet, einen Datenschutzreset anfordert oder wenn automatisierte Tests eine neue Identifikationsnummer benötigen.

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

Erwartungen an die Persistenz

Android kann über den Uninstall und Reinstall, einschließlich Android Studio und Play-Installations mit verschiedenen Signaturschlüsseln, überleben, wenn der Paketname oder der benutzerdefinierte Scope stabil ist.
iOS überlebt App-Updates und iOS-Updates, solange die Zugriffsregeln für den Schlüsselkasten gleich bleiben.
Web verwendet localStorage und ist nur ein Entwicklungsfall zurück.

Weiter von Getting Started

Wenn Sie persistenten App-Identität verwenden Getting Started zum Hinzufügen von persistenten App-Identität, verbinden Sie es mit @capgo/capacitor-persistent-uuid für die Übersicht Android-Verhalten für das Wiederinstallationsverhalten iOS-Verhalten für das Keychain-Verhalten Mit @capgo/capacitor-persistent-uuid für die Anleitung und Capgo Plugin-Verzeichnis für andere native Plugins.