jubo-sdk 1.1.4 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +389 -385
- package/dist/JuboSdk.d.ts +4 -0
- package/dist/OldJuboSdk.d.ts +4 -0
- package/dist/channelMessage/ChannelClient.d.ts +52 -0
- package/dist/channelMessage/ChannelParent.d.ts +19 -0
- package/dist/channelMessage/index.d.ts +3 -0
- package/dist/index.cjs.js +2853 -1667
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +2852 -1668
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +2853 -1667
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/types/juboSdk.d.ts +6 -1
- package/dist/utils/index.d.ts +5 -3
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -1,385 +1,389 @@
|
|
|
1
|
-
# **JuboSdk** **API** **文档**
|
|
2
|
-
|
|
3
|
-
## **构造函数**
|
|
4
|
-
|
|
5
|
-
```
|
|
6
|
-
new JuboSdk(options: JuboSdkOptions);
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
### **参数**
|
|
10
|
-
|
|
11
|
-
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
12
|
-
| ------- | -------------- | -------- | ------- | ------ |
|
|
13
|
-
| options | JuboSdkOptions | 是 | 无 | 配置参数 |
|
|
14
|
-
|
|
15
|
-
### **options参数说明**
|
|
16
|
-
|
|
17
|
-
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
18
|
-
| ------------------ | -------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | --------------------- |
|
|
19
|
-
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 是 | 无 | app名称 |
|
|
20
|
-
| oldAppVersion | string | 是 | 无 | app旧版本, 用于判断是否使用新版sdk |
|
|
21
|
-
| ojbRouter | [OjbRouter](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-XFz0dd8FioFkJTxWbGlciCr9nce)[] | 是 | 无 | ojb路由 |
|
|
22
|
-
| appHome | string | 否 | 无 | 跳转的首页 |
|
|
23
|
-
| miniProgramAppId | string | 否 |
|
|
24
|
-
| miniProgramLogin | string | 否 | /pages/login/index | 小程序的登录页 |
|
|
25
|
-
| miniProgramTabBar | string[] | 否 | ['/pages/home/index','/pages/boxHome/index','/pages/csgoPage/index','/pages/mine/index','/pages/ipHome/index'] | 小程序tabBar页面列表 |
|
|
26
|
-
| miniProgramPayPage | string | 否 | 无 | 小程序支付页 |
|
|
27
|
-
| handleOjbUrlFn | (url: string) => string | 否 | 无 | 自定义处理ojb协议函数 |
|
|
28
|
-
|
|
29
|
-
#### AppName枚举值
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
/** 元气玛特 */
|
|
33
|
-
Airmart = "Airmart",
|
|
34
|
-
/** 赛高 */
|
|
35
|
-
Saigo = "Saigo"
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
#### OjbRouter参数说明
|
|
39
|
-
|
|
40
|
-
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
41
|
-
| ------- | ------ | -------- | ------- | ------------------------ |
|
|
42
|
-
| key | string | 是 | 无 | ojb统一标识 |
|
|
43
|
-
| remark | string | 否 | 无 | 说明 |
|
|
44
|
-
| val | string | 是 | 无 | 小程序对应地址，无地址的时候填`[event]` |
|
|
45
|
-
|
|
46
|
-
## **属性**
|
|
47
|
-
|
|
48
|
-
| **属性名** | **类型** | **描述**
|
|
49
|
-
| ------------- | --------------------------------------------------------------------------------------------------------- |
|
|
50
|
-
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 只读属性，app名称
|
|
51
|
-
| isApp | boolean | 只读属性，返回当前是否为app。
|
|
52
|
-
| isMiniProgram | boolean | 只读属性，返回当前是否为小程序。
|
|
53
|
-
| isIos | boolean | 只读属性，返回当前是否为iOS设备。
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
146
|
-
|
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
|
159
|
-
|
|
|
160
|
-
|
|
161
|
-
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
|
174
|
-
|
|
|
175
|
-
|
|
176
|
-
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
|
203
|
-
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
|
217
|
-
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
|
256
|
-
| ------- |
|
|
257
|
-
|
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
|
290
|
-
| ------- |
|
|
291
|
-
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
|
300
|
-
|
|
|
301
|
-
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
|
346
|
-
| ------- |
|
|
347
|
-
|
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
|
356
|
-
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
1
|
+
# **JuboSdk** **API** **文档**
|
|
2
|
+
|
|
3
|
+
## **构造函数**
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
new JuboSdk(options: JuboSdkOptions);
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
### **参数**
|
|
10
|
+
|
|
11
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
12
|
+
| ------- | -------------- | -------- | ------- | ------ |
|
|
13
|
+
| options | JuboSdkOptions | 是 | 无 | 配置参数 |
|
|
14
|
+
|
|
15
|
+
### **options参数说明**
|
|
16
|
+
|
|
17
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
18
|
+
| ------------------ | -------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | --------------------- |
|
|
19
|
+
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 是 | 无 | app名称 |
|
|
20
|
+
| oldAppVersion | string | 是 | 无 | app旧版本, 用于判断是否使用新版sdk |
|
|
21
|
+
| ojbRouter | [OjbRouter](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-XFz0dd8FioFkJTxWbGlciCr9nce)[] | 是 | 无 | ojb路由 |
|
|
22
|
+
| appHome | string | 否 | 无 | 跳转的首页 |
|
|
23
|
+
| miniProgramAppId | string | 否 | 元气的小程序appid: *wxc2f42496fb5f5b91* | 小程序appid |
|
|
24
|
+
| miniProgramLogin | string | 否 | /pages/login/index | 小程序的登录页 |
|
|
25
|
+
| miniProgramTabBar | string[] | 否 | ['/pages/home/index','/pages/boxHome/index','/pages/csgoPage/index','/pages/mine/index','/pages/ipHome/index'] | 小程序tabBar页面列表 |
|
|
26
|
+
| miniProgramPayPage | string | 否 | 无 | 小程序支付页 |
|
|
27
|
+
| handleOjbUrlFn | (url: string) => string | 否 | 无 | 自定义处理ojb协议函数 |
|
|
28
|
+
|
|
29
|
+
#### AppName枚举值
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
/** 元气玛特 */
|
|
33
|
+
Airmart = "Airmart",
|
|
34
|
+
/** 赛高 */
|
|
35
|
+
Saigo = "Saigo"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### OjbRouter参数说明
|
|
39
|
+
|
|
40
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
41
|
+
| ------- | ------ | -------- | ------- | ------------------------ |
|
|
42
|
+
| key | string | 是 | 无 | ojb统一标识 |
|
|
43
|
+
| remark | string | 否 | 无 | 说明 |
|
|
44
|
+
| val | string | 是 | 无 | 小程序对应地址，无地址的时候填`[event]` |
|
|
45
|
+
|
|
46
|
+
## **属性**
|
|
47
|
+
|
|
48
|
+
| **属性名** | **类型** | **描述** |
|
|
49
|
+
| ------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
50
|
+
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 只读属性，app名称 |
|
|
51
|
+
| isApp | boolean | 只读属性，返回当前是否为app。 |
|
|
52
|
+
| isMiniProgram | boolean | 只读属性，返回当前是否为小程序。 |
|
|
53
|
+
| isIos | boolean | 只读属性，返回当前是否为iOS设备。 |
|
|
54
|
+
| isH5 | boolean | 只读属性，返回当前是否为H5设备。(版本：1.2.0) |
|
|
55
|
+
| isIframe | boolean | 只读属性，返回当前是否为iframe。(版本：1.2.0) |
|
|
56
|
+
| isCanShowNav | boolean | 只读属性，返回当前是否可以显示自定义导航栏。(弃用属性) |
|
|
57
|
+
| device | `ios` | `android` | `wx` | 只读属性，返回当前设备类型。 |
|
|
58
|
+
| version | string | 只读属性，返回当前sdk版本号。 |
|
|
59
|
+
| channel | string | 只读属性，返回当前渠道。 |
|
|
60
|
+
| isOldApp | boolean | 只读属性，返回当前app是否为旧版本。(兼容属性) |
|
|
61
|
+
|
|
62
|
+
## 方法
|
|
63
|
+
|
|
64
|
+
> 如果方法有平台差异的时候，会显示平台差异说明
|
|
65
|
+
|
|
66
|
+
### **getToken()**
|
|
67
|
+
|
|
68
|
+
获取token
|
|
69
|
+
|
|
70
|
+
#### 平台差异说明
|
|
71
|
+
|
|
72
|
+
| **ios** | **android** | **小程序** |
|
|
73
|
+
| ------- | ----------- | ------- |
|
|
74
|
+
| √ | √ | x |
|
|
75
|
+
|
|
76
|
+
#### 返回参数说明
|
|
77
|
+
|
|
78
|
+
| **参数名** | **类型** | **描述** |
|
|
79
|
+
| ------- | ---------------- | ----------------------------- |
|
|
80
|
+
| token | Promise<string> | 字符串类型的Promise对象，代表获取到的token值。 |
|
|
81
|
+
|
|
82
|
+
### **goLogin()**
|
|
83
|
+
|
|
84
|
+
跳转登录
|
|
85
|
+
|
|
86
|
+
#### 返回参数说明
|
|
87
|
+
|
|
88
|
+
| **参数名** | **类型** | **描述** | **平台差异说明** |
|
|
89
|
+
| ------- | ---------------- | ----------------------------- | ------------------------------------- |
|
|
90
|
+
| token | Promise<string> | 字符串类型的Promise对象，代表获取到的token值。 | 小程序登录成功后会刷新页面，`刷新后的页面为当前webview进入的首页` |
|
|
91
|
+
|
|
92
|
+
### **goRoute(route: string, isRedirect?:** **boolean** **)**
|
|
93
|
+
|
|
94
|
+
跳转路由
|
|
95
|
+
|
|
96
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
97
|
+
| ---------- | ------- | -------- | ------- | --------------------- | ---------- |
|
|
98
|
+
| route | string | 是 | 无 | 路由路径 | |
|
|
99
|
+
| isRedirect | boolean | 否 | false | 是否使用重定向方式跳转(*仅小程序有效*) | 小程序有效 |
|
|
100
|
+
|
|
101
|
+
### **shareMiniProgram(options: ShareMiniProgramOptions, trackData?: Record<string, any>)**
|
|
102
|
+
|
|
103
|
+
分享微信小程序
|
|
104
|
+
|
|
105
|
+
> *app端调用会自动上传神策* *埋点*
|
|
106
|
+
|
|
107
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
108
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | -------------- |
|
|
109
|
+
| options | [ShareMiniProgramOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-VtJDdQrzIoxckKxeT8Uc7hMCneh) | 是 | 无 | 分享参数配置 |
|
|
110
|
+
| trackData | Record<string, any> | 否 | 无 | *神策* *埋点* *数据* |
|
|
111
|
+
|
|
112
|
+
#### ShareMiniProgramOptions的结构
|
|
113
|
+
|
|
114
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
115
|
+
| ------------- | -------------------------------------------------------------------------------------------------------------- | -------- | ------------------------ | ----------------------------------- | ---------- |
|
|
116
|
+
| title | string | 是 | 无 | *分享标题* | |
|
|
117
|
+
| descr | string | 否 | 无 | *分享描述* | |
|
|
118
|
+
| webpage | string | 是 | 无 | *小程序路径* | |
|
|
119
|
+
| appid | string | 否 | options.miniProgramAppId | 小程序原始id (版本: 1.1.4) | 仅app有效 |
|
|
120
|
+
| thumbImage | string | 否 | 无 | *分享图* | |
|
|
121
|
+
| base64 | string | 否 | 无 | *base64分享图, 仅app有效, 与thumbImage二选一* | 仅app有效 |
|
|
122
|
+
| activity_id | string | 否 | 无 | *活动id* | |
|
|
123
|
+
| activity_name | string | 否 | 无 | *活动名称* | |
|
|
124
|
+
| product_id | string | 否 | 无 | *商品id* | |
|
|
125
|
+
| product_name | string | 否 | 无 | *商品名称* | |
|
|
126
|
+
| saInfo | any | 否 | 无 | *神策* *埋点* *数据* | |
|
|
127
|
+
| shareOptions | [shareOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-SjsvdDkEkosFLExULY8c4Gwen7b) | 否 | 无 | *分享选项* | 仅小程序有效 |
|
|
128
|
+
|
|
129
|
+
#### shareOptions的结构
|
|
130
|
+
|
|
131
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
132
|
+
| --------- | ------- | -------- | ------- | ------ |
|
|
133
|
+
| isRefresh | boolean | 否 | 无 | *是否刷新* |
|
|
134
|
+
| ... | | | | |
|
|
135
|
+
|
|
136
|
+
### postReport(keyName: string, data: Record<string, any>)
|
|
137
|
+
|
|
138
|
+
原生埋点协助上报
|
|
139
|
+
|
|
140
|
+
#### 平台差异说明
|
|
141
|
+
|
|
142
|
+
| **ios** | **android** | **小程序** |
|
|
143
|
+
| ------- | ----------- | ------- |
|
|
144
|
+
| √ | √ | x |
|
|
145
|
+
|
|
146
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
147
|
+
| ------- | -------------------- | -------- | ------- | ------ |
|
|
148
|
+
| keyName | string | 是 | 无 | 埋点key |
|
|
149
|
+
| data | Record<string, any> | 是 | 无 | 上报数据 |
|
|
150
|
+
|
|
151
|
+
### sensorsReport(keyName: string, data: Record<string, any>)
|
|
152
|
+
|
|
153
|
+
原生埋点神策直接上报
|
|
154
|
+
|
|
155
|
+
#### 平台差异说明
|
|
156
|
+
|
|
157
|
+
| **ios** | **android** | **小程序** |
|
|
158
|
+
| ------- | ----------- | ------- |
|
|
159
|
+
| √ | √ | x |
|
|
160
|
+
|
|
161
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
162
|
+
| ------- | -------------------- | -------- | ------- | ------ |
|
|
163
|
+
| keyName | string | 是 | 无 | 埋点key |
|
|
164
|
+
| data | Record<string, any> | 是 | 无 | 上报数据 |
|
|
165
|
+
|
|
166
|
+
### shareWXImg(params: ShareImgData)
|
|
167
|
+
|
|
168
|
+
图片微信分享
|
|
169
|
+
|
|
170
|
+
#### 平台差异说明
|
|
171
|
+
|
|
172
|
+
| **ios** | **android** | **小程序** |
|
|
173
|
+
| ------- | ----------- | ------- |
|
|
174
|
+
| √ | √ | x |
|
|
175
|
+
|
|
176
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
177
|
+
| ------- | ----------------- | -------- | ------- | ------------------------------ |
|
|
178
|
+
| base64 | string | 是 | 无 | base64图片 |
|
|
179
|
+
| type | `0` | `1` | `2` | 否 | 0 | 分享方式 （0 = 好友列表 1 = 朋友圈 2 = 收藏） |
|
|
180
|
+
|
|
181
|
+
### setNavTitle(title: string)
|
|
182
|
+
|
|
183
|
+
设置导航栏标题
|
|
184
|
+
|
|
185
|
+
#### 平台差异说明
|
|
186
|
+
|
|
187
|
+
| **ios** | **android** | **小程序** |
|
|
188
|
+
| ------- | ----------- | ------- |
|
|
189
|
+
| √ | √ | x |
|
|
190
|
+
|
|
191
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
192
|
+
| ------- | ------ | -------- | ------- | ------ |
|
|
193
|
+
| title | string | 是 | 无 | 标题 |
|
|
194
|
+
|
|
195
|
+
### hideNavBar(isHide: boolean)
|
|
196
|
+
|
|
197
|
+
隐藏或显示原生导航栏
|
|
198
|
+
|
|
199
|
+
#### 平台差异说明
|
|
200
|
+
|
|
201
|
+
| **ios** | **android** | **小程序** |
|
|
202
|
+
| ------- | ----------- | ------- |
|
|
203
|
+
| √ | √ | x |
|
|
204
|
+
|
|
205
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
206
|
+
| ------- | ------- | -------- | ------- | ------ |
|
|
207
|
+
| isHide | boolean | 是 | 无 | 是否隐藏 |
|
|
208
|
+
|
|
209
|
+
### setOrientation(isLandscape: boolean)
|
|
210
|
+
|
|
211
|
+
设置横竖屏
|
|
212
|
+
|
|
213
|
+
#### 平台差异说明
|
|
214
|
+
|
|
215
|
+
| **ios** | **android** | **小程序** |
|
|
216
|
+
| ------- | ----------- | ------- |
|
|
217
|
+
| √ | √ | x |
|
|
218
|
+
|
|
219
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
220
|
+
| ----------- | ------- | -------- | ------- | ------ |
|
|
221
|
+
| isLandscape | boolean | 是 | 无 | 是否横屏 |
|
|
222
|
+
|
|
223
|
+
### toPayPage(options: ToPayPageOptions): Promise<boolean | string>
|
|
224
|
+
|
|
225
|
+
拉起原生充值页面，充值成功或失败时有回调
|
|
226
|
+
|
|
227
|
+
> 小程序调用方法后是跳转小程序的支付页
|
|
228
|
+
|
|
229
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
230
|
+
| ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ------ |
|
|
231
|
+
| options | [ToPayPageOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-QL4JdObjNo0tbHxwk6YcCOaKn2f) | 是 | 无 | 是否横屏 |
|
|
232
|
+
|
|
233
|
+
#### ToPayPageOptions的结构
|
|
234
|
+
|
|
235
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
236
|
+
| ---------- | ------ | -------- | ------- | -------------- | ---------- |
|
|
237
|
+
| orderId | string | 否 | 无 | 订单id（版本：1.2.0） | |
|
|
238
|
+
| amount | string | 是 | 无 | 充值金额 | |
|
|
239
|
+
| activityId | string | 是 | 无 | 活动ID | |
|
|
240
|
+
| success | string | 否 | 无 | 支付成功的回调地址 | 仅小程序有效 |
|
|
241
|
+
| fail | string | 否 | 无 | 支付失败的回调地址 | 仅小程序有效 |
|
|
242
|
+
|
|
243
|
+
#### 返回参数说明
|
|
244
|
+
|
|
245
|
+
| **参数名** | **类型** | **描述** | **平台差异说明** |
|
|
246
|
+
| --------- | ----------------- | ------------------------------- | ---------- |
|
|
247
|
+
| isSuccess | Promise<boolean> | boolean类型的Promise对象, `true`代表成功 | 仅app有效 |
|
|
248
|
+
|
|
249
|
+
### hideStatusBar(isHide: boolean)
|
|
250
|
+
|
|
251
|
+
隐藏或显示状态栏
|
|
252
|
+
|
|
253
|
+
#### 平台差异说明
|
|
254
|
+
|
|
255
|
+
| **ios** | **android** | **小程序** |
|
|
256
|
+
| ------- | ----------- | ------- |
|
|
257
|
+
| √ | √ | x |
|
|
258
|
+
|
|
259
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
260
|
+
| ------- | ------- | -------- | ------- | ------ |
|
|
261
|
+
| isHide | boolean | 是 | 无 | 是否隐藏 |
|
|
262
|
+
|
|
263
|
+
### quit()
|
|
264
|
+
|
|
265
|
+
返回到原生上一页面
|
|
266
|
+
|
|
267
|
+
#### 平台差异说明
|
|
268
|
+
|
|
269
|
+
| **ios** | **android** | **小程序** |
|
|
270
|
+
| ------- | ----------- | ------- |
|
|
271
|
+
| √ | √ | x |
|
|
272
|
+
|
|
273
|
+
### goBack()
|
|
274
|
+
|
|
275
|
+
返回路由上一级，没有路由上一级会退到原生上一页面
|
|
276
|
+
|
|
277
|
+
#### 平台差异说明
|
|
278
|
+
|
|
279
|
+
| **ios** | **android** | **小程序** |
|
|
280
|
+
| ------- | ----------- | ------- |
|
|
281
|
+
| √ | √ | x |
|
|
282
|
+
|
|
283
|
+
### shareHtml(options: ShareHtmlOptions)
|
|
284
|
+
|
|
285
|
+
分享H5页面到微信
|
|
286
|
+
|
|
287
|
+
#### 平台差异说明
|
|
288
|
+
|
|
289
|
+
| **ios** | **android** | **小程序** |
|
|
290
|
+
| ------- | ----------- | ------- |
|
|
291
|
+
| √ | √ | x |
|
|
292
|
+
|
|
293
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
294
|
+
| ------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ------ |
|
|
295
|
+
| options | [ShareHtmlOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-Iwtgdg8EtoxXDhxlRLwc61LWnte) | 是 | 无 | 参数 |
|
|
296
|
+
|
|
297
|
+
#### ShareHtmlOptions的结构
|
|
298
|
+
|
|
299
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
300
|
+
| -------- | ----------------- | -------- | ------- | ------------------------------ | ---------- |
|
|
301
|
+
| title | string | 是 | 无 | 分享标题 | |
|
|
302
|
+
| desc | string | 是 | 无 | 分享描述 | |
|
|
303
|
+
| url | string | 是 | 无 | 分享链接 | |
|
|
304
|
+
| imageUrl | string | 是 | 无 | 分享图 | |
|
|
305
|
+
| type | `0` | `1` | `2` | 否 | 0 | 分享方式 （0 = 好友列表 1 = 朋友圈 2 = 收藏） | |
|
|
306
|
+
|
|
307
|
+
### checkAppNotice(): Promise<boolean>
|
|
308
|
+
|
|
309
|
+
检查App推送通知权限，若没打开会有自定义弹窗提示用户去打开
|
|
310
|
+
|
|
311
|
+
#### 平台差异说明
|
|
312
|
+
|
|
313
|
+
| **ios** | **android** | **小程序** |
|
|
314
|
+
| ------- | ----------- | ------- |
|
|
315
|
+
| √ | √ | x |
|
|
316
|
+
|
|
317
|
+
#### 返回参数说明
|
|
318
|
+
|
|
319
|
+
| **参数名** | **类型** | **描述** |
|
|
320
|
+
| ------- | ----------------- | ---------------------------- |
|
|
321
|
+
| isOpen | Promise<boolean> | boolean类型的Promise对象，代表是否打开通知 |
|
|
322
|
+
|
|
323
|
+
### checkNetStatus(): Promise<NetStatus>
|
|
324
|
+
|
|
325
|
+
检查网络状态
|
|
326
|
+
|
|
327
|
+
#### 平台差异说明
|
|
328
|
+
|
|
329
|
+
| **ios** | **android** | **小程序** |
|
|
330
|
+
| ------- | ----------- | ------- |
|
|
331
|
+
| √ | √ | x |
|
|
332
|
+
|
|
333
|
+
#### 返回参数说明
|
|
334
|
+
|
|
335
|
+
| **参数名** | **类型** | **描述** |
|
|
336
|
+
| --------- | ----------------- | -------------------------- |
|
|
337
|
+
| NetStatus | `0` | `1` | `2` | 网络状态 (0 无网络 1 手机网络 2 wifi) |
|
|
338
|
+
|
|
339
|
+
### hcAuthorization(options: HcAuthorizationOptions): Promise<HcAuthorizationData>
|
|
340
|
+
|
|
341
|
+
幻潮授权
|
|
342
|
+
|
|
343
|
+
#### 平台差异说明
|
|
344
|
+
|
|
345
|
+
| **ios** | **android** | **小程序** |
|
|
346
|
+
| ------- | ----------- | ------- |
|
|
347
|
+
| √ | √ | x |
|
|
348
|
+
|
|
349
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
350
|
+
| ------- | ------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ------ |
|
|
351
|
+
| options | [HcAuthorizationOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-S7pvdVjxiobBr0xhYxJcC2M6nyb) | 是 | 无 | 参数 |
|
|
352
|
+
|
|
353
|
+
#### HcAuthorizationOptions的结构
|
|
354
|
+
|
|
355
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** |
|
|
356
|
+
| ------------------ | ------ | -------- | ------- | ------------------------ |
|
|
357
|
+
| title | string | 是 | 无 | 授权页面标题 |
|
|
358
|
+
| access_token | string | 是 | 无 | 访问token |
|
|
359
|
+
| redirect_url | string | 否 | 无 | 成功的回调地址 (旧版sdk使用) (兼容属性) |
|
|
360
|
+
| error_redirect_url | string | 否 | 无 | 失败的回调地址 (旧版sdk使用) (兼容属性) |
|
|
361
|
+
|
|
362
|
+
#### 返回参数(HcAuthorizationData)说明
|
|
363
|
+
|
|
364
|
+
| **参数名** | **类型** | **描述** |
|
|
365
|
+
| --------- | ------- | ------- |
|
|
366
|
+
| isSuccess | boolean | 是否成功 |
|
|
367
|
+
| loginCode | string | 授权成功后有值 |
|
|
368
|
+
|
|
369
|
+
### getStatusBarHeight(): number
|
|
370
|
+
|
|
371
|
+
获取状态栏高度
|
|
372
|
+
|
|
373
|
+
> ios如果是刘海屏会返回44, 否则返回20, android返回系统获取的状态栏高度
|
|
374
|
+
|
|
375
|
+
#### 平台差异说明
|
|
376
|
+
|
|
377
|
+
| **ios** | **android** | **小程序** |
|
|
378
|
+
| ------- | ----------- | ------- |
|
|
379
|
+
| √ | √ | x |
|
|
380
|
+
|
|
381
|
+
#### 返回参数说明
|
|
382
|
+
|
|
383
|
+
| **参数名** | **类型** | **描述** |
|
|
384
|
+
| ------- | ------ | ------ |
|
|
385
|
+
| height | number | 状态栏高度 |
|
|
386
|
+
|
|
387
|
+
### goHome()
|
|
388
|
+
|
|
389
|
+
跳转到首页
|