Getting Started

GitHub

Ein Setup-Vorschlag kopieren mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen 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.

Installieren

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

Importieren

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

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 die gleiche UUID für den gleichen Bereich zurück.

Verwende einen stabilen benutzerdefinierten Bereich

Die native Standard-Scope ist der Paketname auf Android und der Bundle-Identifier auf iOS. Wenn sich Debug- und Produktionsbuilds unterschiedliche Paket-Identifikatoren haben, aber eine gemeinsame UUID verwenden sollen, übergeben Sie einen gemeinsamen Scope.

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

UUID zurücksetzen

Wenn der Benutzer sich abmeldet, eine Datenschutz-Restellung anfordert oder automatisierte Tests eine neue Identifikation benötigen, rufen Sie resetId auf.

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

Persistenz-Erwartungen

Android kann sich bei einem Entfernen und erneuten Installieren, einschließlich Android Studio und Play-Instanzen mit unterschiedlichen Signierungsschlüsseln, halten, wenn der Paketname oder der benutzerdefinierte Scope stabil ist.
iOS überlebt App-Updates und iOS-Updates, solange die Zugriffsregeln für den Schlüsselbund gleich bleiben.
Web verwendet localStorage und ist nur ein Entwicklungsfall zurück.

Weiter zum Thema 'Getting Started'

Wenn Sie Getting Started benutzen, um eine persistente App-Identität hinzuzufügen, verbinden Sie sie 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 den Tutorial und Capgo Plugin-Verzeichnis für andere native Plugins.