Web SDK 参考

初始化

.initialize

初始化 SDK。

参数

options: InitializeOptions
- projectId
- （可选）serviceWorkerPath

FlareLane.initialize({
  projectId: "<PROJECT_ID>",
  serviceWorkerPath: "/sw.js" // optional
});

.setLogLevel

设置 SDK 的日志级别。

参数

logLevel: 'none' | 'error' | 'verbose'
- none：不输出任何内容
- error：仅输出错误
- verbose：输出全部内容（默认）

FlareLane.setLogLevel('verbose');

通知订阅

.getIsSubscribed

检查当前设备是否已订阅。

参数

callback: (Boolean) => {}

FlareLane.getIsSubscribed((isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
});

.setIsSubscribed

设置当前设备的订阅状态。

当您希望直接管理订阅状态时（例如通过您服务中的设置界面），请使用此方法。

设置为 true 时，订阅所需的整套权限授权流程会一步触发。

参数

isSubscribed: Boolean
callback: (Boolean) => {}

const callback = (isSubscribed) => {
    // Do something...
    console.log(isSubscribed);
};

// SUBSCRIBE
FlareLane.setIsSubscribed(true, callback);
// UNSUBSCRIBE
FlareLane.setIsSubscribed(false, callback);

客户数据集成

.setUserId

设置当前设备的用户 ID。通常，您会在用户注册或登录成功后更新用户 ID。

参数

userId: string | null

// SET
FlareLane.setUserId("USER_ID");
// REMOVE
FlareLane.setUserId(null);

.trackEvent

触发一个事件。如果设备已设置用户 ID，事件会应用到该用户；否则，应用到该设备本身。

参数

type: string
（可选）data: Record<string, string | number>

FlareLane.trackEvent('test_event');
// OR
FlareLane.trackEvent('test_event', { "dataKey": "dataValue" });

.setTags

应用标签。如果设备已设置用户 ID，标签会应用到该用户；否则，应用到该设备本身。

参数

tags: Record<string, string | number>

// SET
FlareLane.setTags({ gender: "men", age: 24 });

.setUserAttributes

应用用户画像。

参数

userAttributes: Record<string, string>

// SET
FlareLane.setUserAttributes({
  "name": "John Smith",
  "phoneNumber": "+12025550123",
  "dob": "1992-03-01",
  "email": "kevin@flarelane.com",
  "country": "US",
  "language": "en",
  "timeZone": "America/New_York"
});

.getDeviceId

获取当前设备的 FlareLane 设备 ID。

参数

callback: (string | null) => {}

FlareLane.getDeviceId((deviceId) => {
    // Do something...
    console.log(deviceId);
 });

通知处理器

.setConvertedHandler

注册一个回调处理器，当用户点击通知后进入您的服务时执行。

参数

callback: (Notification) => {}

FlareLane.setConvertedHandler((notification) => {
    // Do something...
    console.log(notification);
 });

应用内消息

.displayInApp

显示当前设备符合展示条件、来自指定分组中优先级最高的应用内消息。

FlareLane.displayInApp("home");

.setInAppMessageActionHandler

定义您自己的处理器，以处理由应用内消息触发的自定义操作。

FlareLane.setInAppMessageActionHandler((iam, actionId) => {
  // Do Something...
});