开始使用
安装
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.
您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 能力添加到您的 AI 工具中:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-persistent-uuid` plugin in my project.如果您prefer手动设置,安装插件并运行以下命令,然后按照以下平台特定的说明进行操作:
bun add @capgo/capacitor-persistent-uuidbunx cap syncimport { PersistentUuid } from '@capgo/capacitor-persistent-uuid';读取或创建 UUID
Section titled “读取或创建 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,相同的范围内。
使用稳定的自定义范围
Section titled “使用稳定的自定义范围”原生默认范围是 Android 的包名和 iOS 的 bundle 标识符。如果 debug 和生产构建使用不同的包标识符但应该共享一个 UUID,请传递一个共享范围。
const result = await PersistentUuid.getId({ scope: 'com.example.app',});重置 UUID
Section titled “重置 UUID”当用户注销登录、请求隐私重置或自动化测试需要新标识符时,调用resetId()。
const replacement = await PersistentUuid.resetId();console.log(replacement.id);持久性期望
持久性期望部分- 在安卓上,应用程序可以在卸载和重新安装(包括安卓 studio 和 play 安装)时保持稳定,包括不同的签名密钥和包名或自定义范围。
- 在 iOS 上,应用程序可以在应用程序更新和 iOS 更新时保持稳定,前提是密钥链访问规则保持不变。
- 在 Web 上,使用 localStorage 作为开发者fallback。
继续从开始
继续从开始部分如果您正在使用 开始 来添加持久性应用程序标识,连接它与 @capgo/capacitor-persistent-uuid 了解更多 Android 行为 重新安装行为 iOS 行为 Keychain 行为 使用 @capgo/capacitor-persistent-uuid 了解更多 @Capgo 插件目录 了解更多