@@ -25,15 +25,15 @@ authorize二级模块对象,用于处理插件授权登录,获取HBuilderX
2525
2626## login
2727
28- #### 参数说明
28+ #### Parameter
2929
30- | 参数名称 | 参数类型 | 描述 |
30+ | Name | Type | Description |
3131| -- | -- | -- |
3232| params | Object | 授权登录必要的信息|
3333
3434参数属性说明
3535
36- | 属性名 | 属性类型 | 描述 |
36+ | Attribute name | Type | Description |
3737| -- | -- | -- |
3838| client_id | String | 在[ DCloud开发者开放开台] ( https://open.dcloud.net.cn/ ) 添加授权插件后创建的client_id |
3939| scopes | Array< ; String> ; | 授权范围列表, 取值范围:basic, email, phone。basic必填|
@@ -45,20 +45,20 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
4545
4646同时注意在调用login方法后,HBuilderX会弹出授权确认框,用户可能拒绝授权或拒绝授权email、phone等敏感信息。
4747
48- #### 返回值
48+ #### Returns
4949
50- | 返回类型 | 描述 |
50+ | Type | Description |
5151| -- | -- |
5252| Promise< ; Object> ; | Promise对象 |
5353
5454返回值属性说明
5555
56- | 属性名 | 属性类型 | 描述 |
56+ | Attribute name | Type | Description |
5757| -- | -- | -- |
5858| code | String | CODE码,有效期5分钟。用于插件作者服务器端换取accessToken,通过accessToken换取授权的基本信息 |
5959| error | Number | code获取失败时的错误码 |
6060
61- #### 示例
61+ #### Example
6262``` javascript
6363 let prom = hx .authorize .login ({ client_id: " your client id" , scopes: [' basic' , ' email' ,' phone' ], description: " for test" });
6464 prom .then (function (param ) {
@@ -69,7 +69,7 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
6969
7070#### 主要错误码信息
7171
72- | 错误码 | 描述 |
72+ | 错误码 | Description |
7373| -- | -- |
7474| 0 | 无错误 |
7575| 1 | 当前没有登录用户 |
@@ -90,20 +90,20 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
9090## onUserLogin
9191用户登录事件
9292
93- #### 参数说明
93+ #### Parameter
9494
95- | 参数名称 | 参数类型 | 描述 |
95+ | Name | Type | Description |
9696| -- | -- | -- |
9797| callback | Function | 用户登录时的回调函数,无参数|
9898
99- #### 返回值
99+ #### Returns
100100
101- | 返回类型 | 描述 |
101+ | Type | Description |
102102| -- | -- |
103103| [ Disposable] ( #Disposable ) | Disposable |
104104
105105
106- #### 示例
106+ #### Example
107107``` javascript
108108 hx .authorize .onUserLogin (function (){
109109 // do something
@@ -113,19 +113,19 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
113113## onUserLogout
114114当前登录用户退出事件
115115
116- #### 参数说明
116+ #### Parameter
117117
118- | 参数名称 | 参数类型 | 描述 |
118+ | Name | Type | Description |
119119| -- | -- | -- |
120120| callback | Function | 当前登录用户退出时的回调函数,无参数|
121121
122- #### 返回值
122+ #### Returns
123123
124- | 返回类型 | 描述 |
124+ | Type | Description |
125125| -- | -- |
126126| [ Disposable] ( #Disposable ) | Disposable对象 |
127127
128- #### 示例
128+ #### Example
129129``` javascript
130130 hx .authorize .onUserLogout (function (){
131131 // do something
0 commit comments