Appearance
初始化 - init
简介
- 此API是一个异步任务,可使用async await / promise结构 调用;
- 也可直接进行初始化动作,不接受回调值,SDK内部有进行埋码的堆栈,当有埋点缓存时,会自动进行埋点上报。
环境适配说明
| 环境名称 | 是否支持 | jssdk文件最低版本号 | npm包最低版本号 |
|---|---|---|---|
| 湘易办APP-小程序 | ❌ | -- | 0.0.4 |
| 湘易办APP-小程序-webview | ✅ | 1.1.4 | 0.0.4 |
| 湘易办APP-webview | ✅ | 1.1.4 | 0.0.4 |
| 三方H5 | ✅ | 1.1.4 | 0.0.4 |
| 三方小程序-H5 | ✅ | 2.0.0 | 0.0.4 |
参数
- 非H5环境不需要执行初始化
- 执行初始化时,无需传入任何参数,SDK会自行判断
生产(production)、非生产(development)环境,进行数据上报;
| 参数名 | 类型 | 可选值 | 描述 |
|---|---|---|---|
| envType | String | [development, production] | 环境类型,默认为非生产环境 |
返回值
此API是一个异步任务,需使用async await / promise结构 获取回调值
| 参数名 | 类型 | 描述 |
|---|---|---|
| result | Boolean | 初始化是否完成 |
示例
javascript
// exp.1 默认初始化
const res = await $xybAgent.init();
if (res) {
// 初始化完成
}
// exp.2 指定环境初始化 - 上报到生产
const res = await $xybAgent.init('production');
if (res) {
// 初始化完成
}
// exp.3 指定环境初始化 - 上报到非生产
const res = await $xybAgent.init('development');
if (res) {
// 初始化完成
}javascript
// exp.1 默认初始化
$xybAgent.init().then(res => {
if (res) {
// 初始化完成
}
});
// exp.2 指定环境初始化 - 上报到生产
$xybAgent.init('production').then(res => {
if (res) {
// 初始化完成
}
});
// exp.3 默认初始化 - 上报到非生产
$xybAgent.init('development').then(res => {
if (res) {
// 初始化完成
}
})