开始使用

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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

导入

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

读取或创建 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);

第一次调用创建并存储 UUID，后续调用返回相同的 UUID

使用稳定的自定义范围

使用 native 默认范围是 Android 的包名和 iOS 的 bundle 标识符。如果 debug 和生产构建使用不同的包标识符但应该共享一个 UUID，请传递一个共享范围。

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

重置 UUID

当用户注销登录、请求隐私重置或自动化测试需要新标识符时，请调用 resetId。

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

持久性期望

• 当包名或自定义范围稳定时，Android 可以在卸载和重新安装（包括 Android Studio 和 Play 安装）以及不同签名密钥的安装时存活下来。
• iOS 在 Keychain 访问规则保持不变的情况下可以存活 app 更新和 iOS 更新。
• Web 使用 localStorage，仅作为开发fallback。

继续从 Getting Started

如果您正在使用 开始使用 为添加持久应用标识，连接它与 @capgo/capacitor-persistent-uuid 查看概述 Android 行为 重新安装行为 iOS 行为 查看 Keychain 行为 使用 @capgo/capacitor-persistent-uuid 查看教程 Capgo 插件目录 查看其他本机插件