跳到正文

Identity 安装标识方法 API ​

本文逐项记录 @fast-china/utils 的 Identity 安装标识公开函数。

configureInstallationIdentity 安装标识 ​

在应用入口配置安装标识使用的 Storage 业务键。

签名 ​

ts
export function configureInstallationIdentity(options: InstallationIdentityConfiguration = {}): void;

示例 ​

ts
import { configureInstallationIdentity } from "@fast-china/utils";

configureInstallationIdentity({ cacheKey: "identity:device" });

输入 ​

输入值输入值类型必填/默认值输入值说明
optionsInstallationIdentityConfiguration否,默认 {}安装标识配置;省略 cacheKey 时使用 identity:installation-id。

返回 ​

返回值返回值类型返回值说明
resultvoid没有返回值。

getOrCreateInstallationId 安装标识 ​

返回已有安装标识,否则创建并持久化一个 UUID v4。

签名 ​

ts
export function getOrCreateInstallationId(installationId?: string): string;

示例 ​

ts
import { getOrCreateInstallationId } from "@fast-china/utils";

const result = getOrCreateInstallationId();

输入 ​

输入值输入值类型必填/默认值输入值说明
installationIdstring否可选的显式安装标识;传入时会校验并覆盖当前持久化值。

返回 ​

返回值返回值类型返回值说明
resultstring显式值、内存值、持久化值或新生成值中的最终安装标识。

installationIdentity.getOrCreate 标识 ​

按显式值、内存值、持久化值、随机值的顺序取得安装 UUID。

签名 ​

ts
getOrCreate(installationId?: string): string;

示例 ​

ts
import { installationIdentity } from "@fast-china/utils";

const result = installationIdentity.getOrCreate();

输入 ​

输入值输入值类型必填/默认值输入值说明
installationIdstring否需要覆盖当前值时传入的 UUID v4。

返回 ​

返回值返回值类型返回值说明
resultstring已校验并写入内存和 Local Storage 的 UUID v4。

installationIdentity.read 读取 ​

读取并校验持久化的安装标识,不修改内存中的 deviceId。

签名 ​

ts
read(): string | undefined;

示例 ​

ts
import { installationIdentity } from "@fast-china/utils";

const result = installationIdentity.read();

输入 ​

该方法没有输入参数。

返回 ​

返回值返回值类型返回值说明
resultstring | undefined持久化 UUID v4;缺失或过期时为 undefined。

installationIdentity.clear 清空 ​

删除持久化标识并清空内存中的 deviceId。

签名 ​

ts
clear(): void;

示例 ​

ts
import { installationIdentity } from "@fast-china/utils";

installationIdentity.clear();

输入 ​

该方法没有输入参数。

返回 ​

返回值返回值类型返回值说明
resultvoid没有返回值。