账号

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "service.account"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import account from '@service.account'

或

var account = require("@service.account")

使用限制

接口定义

[h2]account.getProvider(OBJECT)

描述

获取服务提供商，如厂商的英文品牌名称。

返回值

字符串，服务提供商的代号，如果无此服务则返回空字符串。返回空字符串时，请勿调用该服务其他接口，否则将抛出异常。

示例代码

account.getProvider();

[h2]account.authorize(OBJECT)

描述

进行OAuth授权。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

简化模式

account.authorize({
    appid: "101373095",
    type: "token",
    state: "feedbeef",
    scope: "scope.baseProfile",
    success: function (data) {
        console.log("signInByBaseScope Authorize base profile success.");
        var accessToken = data.accessToken;
        console.log("signInByBaseScope Authorize base profile success data=" + JSON.stringify(data));
    },
    fail: function (data, code) {
        console.log("signInByBaseScope Authorize base profile fail, code=" + code);
        prompt.showToast({ message: data + "fail code: " + code })
    }
});

授权码模式

account.authorize({
  appid: "101373095",
  type: "code",
  state: 5,
  scope: "scope.baseProfile",
  redirectUri: "https://www.example.com/",
  success: function (ret) {
    var atcode = ret.code;
    console.log("signInByBaseScope Authorize base profile success data=" + JSON.stringify(ret));
  },
  fail: function (erromsg, errocode) {
    prompt.showToast({ message: 'authorize fail --- ' + errocode + ':' + erromsg });
  }
})

[h2]account.getProfile(OBJECT)

描述

获得用户基本信息。

OBJECT参数

success返回值：

fail返回错误码：

unionid机制说明：

如果开发者拥有多个移动应用，可通过unionid来区分用户的唯一性，因为只要是同一个开放平台账号下的移动应用，用户的unionid是唯一的。换句话说，同一用户，对同一个开放平台下的不同应用，unionid是相同的。

示例代码

account.getProfile({
 appid: "101373095",
    token: this.accessToken,       //使用实际的accessToken值
    success: function (data) {
        console.log('getProfile handling success: ' + JSON.stringify(data));
    },
    fail: function (data, code) {
        console.log('getProfile handling fail, code =' + code);
    }
})

[h2]account.checkUserSession(OBJECT)（1020+）

描述

该接口用于校验应用是否有通过authorize接口完成过登录授权，及应用登录后，账号是否有退出登录的场景。在如下情况下，调用此接口将校验无效：

• 应用未调用authorize进行授权登录
• 应用登录后，用户退出过华为账号，包括退出登录，或退出登录后重新登录

如果希望您的应用和华为账号保持同进同出的状态，在code模式下，建议先调用account.checkUserSession，如果校验无效，再调用account.authorize进行授权。

OBJECT参数

示例代码

account.checkUserSession({
    success: function (data2) {
        // 有效
    },
    fail: function (data, code) {
        // 无效
    }
});

[h2]account.isLogin(OBJECT)（1050+）

描述

该接口用于检查HMS的华为账号是否已经登录。车机设备上不支持。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

account.isLogin({
    success:function(data){
        console.log("handling success,  data.isLogin= " + data.isLogin);
    },
    fail: function(data, code) {
        console.log(`handling fail, code = ${code}`);
    }
})

[h2]account.signOut(OBJECT)

描述

当account.authorize获取的accessToken在调用account.getProfile时返回失效（错误码102），可调用此接口清除缓存，然后再次调用account.authorize获取新的accessToken。仅在车机上适用。

OBJECT参数

fail返回错误码：

示例代码

account.signOut({
    appid: "123456",
    success:function(data){
        console.log("handling success");
    },
    fail: function(data, code) {
        console.log(`handling fail, code = ${code}`);
    }
})

版本更新说明

相关链接

[h2]FAQ

调用account.getProfile返回错误码6200，如何处理？