Skip to content

Commit a0968ee

Browse files
committed
插件登录授权,appid字段修改为client_id
1 parent 96ae346 commit a0968ee

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

ExtensionDocs/Api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1055,7 +1055,7 @@ authorize二级模块对象,用于处理插件授权登录,获取HBuilderX
10551055

10561056
|属性名 |属性类型 |描述 |
10571057
|-- |-- |-- |
1058-
|appId |String |[DCloud开发者开放开台](https://open.dcloud.net.cn/)添加授权插件后创建的appid |
1058+
|client_id |String |[DCloud开发者开放开台](https://open.dcloud.net.cn/)添加授权插件后创建的client_id |
10591059
|scopes |Array<String> | 授权范围列表, 取值范围:basic, email, phone。basic必填|
10601060
|description | String | 关于授权信息描述,可以向用户简单解释插件将如何使用申请的信息(HBuilderX 3.1.7新增) |
10611061

@@ -1080,7 +1080,7 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
10801080

10811081
#### 示例
10821082
``` javascript
1083-
let prom = hx.authorize.login({ appId: "yourappid", scopes: ['basic', 'email','phone'], description: "for test"});
1083+
let prom = hx.authorize.login({ client_id: "your client id", scopes: ['basic', 'email','phone'], description: "for test"});
10841084
prom.then(function (param) {
10851085
// param['code']
10861086
// param['error']
@@ -1098,11 +1098,11 @@ email和phone请谨慎使用,非必要申请授权会招致HBuilderX的用户
10981098
|4 | 插件状态异常 |
10991099
|5 | 用户拒绝授权(用户点击拒绝),或当申请的scopes包含拒绝的授权时会返回该错误码,不影响已通过的授权 |
11001100
|1002 | 服务器参数错误 |
1101-
|2001 | 应用信息不存在,在[DCloud开发者开放开台](https://open.dcloud.net.cn/)检查appid与插件id是否错误或匹配,插件规范参考[这里](/ExtensionDocs/manifest)|
1101+
|2001 | 应用信息不存在,在[DCloud开发者开放开台](https://open.dcloud.net.cn/)检查client_id与插件id是否错误或匹配,插件规范参考[这里](/ExtensionDocs/manifest)|
11021102
|3004 | 超时 |
11031103
|3203 | 404 |
11041104

1105-
- *关于错误码 2001,开发者在创建HBuilderX插件项目,会以填写的项目名称作为插件目录和插件id。插件开发过程中,在[DCloud开发者开放开台](https://open.dcloud.net.cn/)新增授权申请时需要填写此插件id,与生成的appid绑定。最终在提交至插件市场时,如果更换了新的插件id,为保证本地正常开发,需要修改插件目录为新的id,并在[DCloud开发者开放开台](https://open.dcloud.net.cn/)重新提交申请。*
1105+
- *关于错误码 2001,开发者在创建HBuilderX插件项目,会以填写的项目名称作为插件目录和插件id。插件开发过程中,在[DCloud开发者开放开台](https://open.dcloud.net.cn/)新增授权申请时需要填写此插件id,与生成的client_id绑定。最终在提交至插件市场时,如果更换了新的插件id,为保证本地正常开发,需要修改插件目录为新的id,并在[DCloud开发者开放开台](https://open.dcloud.net.cn/)重新提交申请。*
11061106

11071107
- *关于错误码 3,开发者在测试过程中,如果需要重新弹出授权窗口,可以手动删除HBuilderX缓存的加密授权信息记录。Windows平台位置:C:\Users\[UserName]\AppData\Roaming\HBuilder X\prefs, MacOS平台位置:~/Library/Application Support/HBuilder X/prefs,删除该文件[authorization]组下所有内容。*
11081108

0 commit comments

Comments
 (0)