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