uni-app-x API说明

一、启动配置接口

插件启动接口

start(appID: string)

接口说明

参数名	类型	注释
appID	string	博睿SDK平台生成的应用唯一ID

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.start("<#AppID#>")

设置Config地址

私有云客户设置私有部署的config地址时使用。该接口需要在调用start前设置。

setConfigAddress(configAddress: string)

接口说明

参数名	类型	注释
configAddress	string	config地址

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setConfigAddress("<#Config地址#>")

Config地址请于平台上获取或联系技术支持。

设置日志级别

setLogFlag(logFlag: number)

该方法仅支持iOS平台。

接口说明

参数名	类型	注释
logFlag	number	日志级别

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setLogFlag(0xffffffff)

设置App版本

App版本默认在配置文件中获取真实版本号。如有主动配置需求，需要在调用start前调用以下接口设置版本信息。

setAppVersion(appVersion: string)

接口说明

参数名	类型	注释
appVersion	string	需要设置的版本信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setAppVersion("<#APP Version#>")

设置应用环境

使用该接口设置当前应用环境。需要在调用start前调用该接口。

setAppEnvironment(appEnvironment: string)

接口说明

参数名	类型	注释
appEnvironment	string	需要设置的应用环境

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setAppEnvironment("<#APP Environment#>")

设置下载渠道名称

需要在调用start前调用以下接口设置渠道名称。

setChannelID(channelID: string)

接口说明

参数名	类型	注释
channelID	string	需要设置的渠道名称

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setChannelID("<#ChannelID#>")

设置自定义的设备ID

需要在调用start前调用以下接口设置设备ID。

setDeviceID(deviceID: string)

接口说明

参数名	类型	注释
deviceID	string	需要设置的设备ID

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.setDeviceID("<#DeviceID#>")

自定义冷启动结束时间

如需自定义冷启动的结束时机，需要调用以下两个接口完成自定义功能。具体使用方式为：

1.调用自定义冷启动开关接口，开启自定义冷启动功能。（该接口需在插件启动前设置）

useCustomLaunch(used: boolean)

接口说明

参数名	类型	注释
used	boolean	是否使用自定义冷启动结束时间

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.useCustomLaunch(true)

2.在需要的时机调用冷启动结束接口，记录冷启动结束。

recordCustomLaunchEnd()

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.recordCustomLaunchEnd()

注意：开启自定义冷启动功能后，若30s内未调用记录冷启动结束接口，冷启动监控过程会强制结束。

二、数据获取接口

获取设备ID

getDeviceID(): string|null

接口说明

返回值类型	注释
string	插件内嵌SDK中生成的设备ID。如果事先设置了，则返回设置的值

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.getDeviceID()

获取插件内嵌SDK版本

getSDKVersion(): string

接口说明

返回值类型	注释
string	插件内嵌SDK版本号

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用方法
Bonree.getSDKVersion()

三、自定义功能接口

自定义用户信息

插件支持设置与用户相关的信息，从而完成性能数据与实际用户相关联的需求场景。

设置用户信息有两种方式：

1. 设置用户ID，以字符串形式给用户做标识

setUserID(userID: string)

接口说明

参数名	类型	注释
userID	string	用户ID

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setUserID("<#userID#>")

2. 设置用户附加信息

setUserExtraInfo(extraInfo: UTSJSONObject)

接口说明

参数名	类型	注释
extraInfo	UTSJSONObject	用户信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
let userInfo: UTSJSONObject = {
	name: "Jack"
}
Bonree.setUserExtraInfo(userInfo)

3. 添加用户附加信息

addUserExtraInfo(key: string, value: any)

接口说明

参数名	类型	注释
key	string	用户信息键
value	any	用户信息值

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.addUserExtraInfo("grade", "one")

4. 移除用户附加信息

removeUserExtraInfo(key: string)

接口说明

参数名	类型	注释
key	string	用户信息键

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.removeUserExtraInfo("age")

5. 对用户的附加信息进行累加

increaseUserExtraInfo(key: string, value: number)

接口说明

参数名	类型	注释
key	string	用户信息键
value	number	累加的值

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.increaseUserExtraInfo("age", 20)

自定义事件属性

1. 添加事件公共属性（一组）

addEventAttributes(attributes: UTSJSONObject, isLocal: boolean) 

接口说明

参数名	类型	注释
attributes	UTSJSONObject	事件公共属性
isLocal	boolean	是否持久化到本地

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
let eventAttributes = {
	"name": "Jack"
}
Bonree.addEventAttributes(eventAttributes, true)

2. 添加事件公共属性（单条）

addEventAttribute(key: string, value: any, isLocal: boolean)

接口说明

参数名	类型	注释
key	string	事件公共属性键
value	any	事件公共属性值
isLocal	boolean	是否持久化到本地

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.addEventAttribute("name", "Jack", false)

3. 移除事件公共属性

removeEventAttribute(keys: Array<string>)

接口说明

参数名	类型	注释
keys	`Array<string>`	要移除的键

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.removeEventAttribute(["name"])

4. 移除所有事件公共属性

removeAllEventAttributes()

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.removeAllEventAttributes()

自定义异常

调用接口并传入相应参数，可完成自定义异常数据的统计功能。

setCustomException(exceptionType: string, causedBy: string, errorDump: string)

接口说明

参数名	类型	注释
exceptionType	string	异常类型
causedBy	string	异常原因
errorDump	string	异常堆栈

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setCustomException("exceptionType", "reference causedBy", "errorDump")

自定义事件（完整版）

//自定义事件开始
setCustomEventStart(eventID: string, eventName: string, eventLabel: string, param: string, info: UTSJSONObject)
//自定义事件结束
setCustomEventEnd(eventID: string, eventName: string, eventLabel: string, param: string, info: UTSJSONObject)

接口说明

参数名	类型	注释
eventID	string	事件ID
eventName	string	事件名称
eventLabel	string	事件标签
param	string	事件附加信息
info	UTSJSONObject	事件业务信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
let eventAttributes = {
	"name-event": "Jack"
}
Bonree.setCustomEventStart("complete-id-only", "complete-name-begin", "complete-label-begin", "complete-param-begin", eventAttributes)
Bonree.setCustomEventEnd("complete-id-only", "complete-name-end", "complete-label-end", "complete-param-end", eventAttributes)

自定义事件（精简版）

调用接口并传入相应参数，可完成自定义事件数据统计功能。

setCustomEvent(eventID: string, eventName: string, eventLabel: string, param: string, info: UTSJSONObject)

接口说明

参数名	类型	注释
eventID	string	事件ID
eventName	string	事件名称
eventLabel	string	事件标签
param	string	事件附加信息
info	UTSJSONObject	事件业务信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
let eventAttributes = {
	"name": "Jack"
}
Bonree.setCustomEvent("id", "name", "label", "param", eventAttributes)

自定义日志

调用接口并传入相应参数，可完成自定义日志数据统计功能。

setCustomLog(logInfo: string, param: string) 

接口说明

参数名	类型	注释
logInfo	string	日志信息
param	string	附加信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setCustomLog("loginfo", "noparam")

自定义方法

调用接口并传入相应参数，可完成自定义方法数据统计功能。

//自定义方法开始
setCustomMethodStart(methodName: string, param: string)
//自定义方法结束
setCustomMethodEnd(methodName: string, param: string)

接口说明

参数名	类型	注释
methodName	string	方法名称
param	string	附加信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setCustomMethodStart("name", "param")
Bonree.setCustomMethodEnd("name", "param")

设置自定义请求信息接口

调用接口并传入相应参数，可以给匹配到的网络数据关联自定义的字符串信息。

setRequestExtraInfo(headerKey: string, value: string, info: string)

接口说明

参数名	类型	注释
headerKey	string	需要匹配的请求头Key。
value	string	需要匹配的请求头Value。
info	string	关联的自定义信息。

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setRequestExtraInfo("key", "value", "info")

自定义指标

调用接口并传入相应参数，可完成自定义指标数据统计功能。

setCustomMetric(metricName: string, metricValue: Int, param: string)

接口说明

参数名	类型	注释
metricName	string	指标名称
metricValue	Int	指标值
param	string	附加信息

示例

//引入插件
import { Bonree } from '@/uni_modules/bonree-unix-plugin';
//调用
Bonree.setCustomMetric("name", 999, "param")

一、启动配置接口​

插件启动接口​

设置Config地址​

设置日志级别​

设置App版本​

设置应用环境​

设置下载渠道名称​

设置自定义的设备ID​

自定义冷启动结束时间​

二、数据获取接口​

获取设备ID​

获取插件内嵌SDK版本​

三、自定义功能接口​

自定义用户信息​

1. 设置用户ID，以字符串形式给用户做标识​

2. 设置用户附加信息​

3. 添加用户附加信息​

4. 移除用户附加信息​

5. 对用户的附加信息进行累加​

自定义事件属性​

1. 添加事件公共属性（一组）​

2. 添加事件公共属性（单条）​

3. 移除事件公共属性​

4. 移除所有事件公共属性​

自定义异常​

自定义事件 （完整版）​

自定义事件 （精简版）​

自定义日志​

自定义方法​

设置自定义请求信息接口​

自定义指标​