authorize

HBuilderX 3.0.0+起支持

authorize介绍

authorize二级模块对象，用于处理插件授权登录，获取HBuilderX当前登录用户的信息授权。

它是DCloud用户开放平台在HBuilderX插件API中的具体体现。

使用场景：

三方的开发者服务商，比如Git服务商，可以制作HBuilderX插件，并且将账户打通。比如插件注册项目的右键菜单，在HBuilderX中对项目点右键，一键上传到某Git服务商，且无需再重复注册三方Git服务账户。

当然不止是Git服务商，所有其他开发者服务商，如测试、加固、多渠道发布、招聘…，均可通过DCloud用户开放平台共享DCloud的开发者资源。

使用步骤：

1. 三方开发商需要在DCloud用户开放平台注册插件应用
2. 开发HBuilderX插件，调用 hx.authorize.login API，拿到code码。（见下面文档）
3. 插件将code码传到三方开发商服务器，从服务器端向 DCloud用户开放平台 的服务器请求，获取用户信息。文档详见：https://ask.dcloud.net.cn/article/38005

对应的效果如下图所示：

login

参数说明

参数属性说明

basic包括用户的openid、昵称、头像。

email和phone请谨慎使用，非必要申请授权会招致HBuilderX的用户反感。

同时注意在调用login方法后，HBuilderX会弹出授权确认框，用户可能拒绝授权或拒绝授权email、phone等敏感信息。

返回值

返回值属性说明

示例

    let prom = hx.authorize.login({ client_id: "your client id", scopes: ['basic', 'email','phone'], description: "for test"});
    prom.then(function (param) {
        // param['code']
        // param['error']
    });

主要错误码信息

• 关于错误码 2001，开发者在创建HBuilderX插件项目，会以填写的项目名称作为插件目录和插件id。插件开发过程中，在DCloud开发者开放开台新增授权申请时需要填写此插件id，与生成的client_id绑定。最终在提交至插件市场时，如果更换了新的插件id，为保证本地正常开发，需要修改插件目录为新的id，并在DCloud开发者开放开台重新提交申请。

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

onUserLogin

用户登录事件

参数说明

返回值

示例

    hx.authorize.onUserLogin(function(){
        // do something
    });

onUserLogout

当前登录用户退出事件

参数说明

返回值

示例

    hx.authorize.onUserLogout(function(){
        // do something
    });