@hw-hmscore/hms-jsb-account v6.11.0-300

概述

帐号开发鸿蒙 HMS Core 适配 JavaScript API

类定义

HuaweiIdAuthManager

account 对外 JavaScript API 门面类

Kind: global constant

• HuaweiIdAuthManager
  • getAuthApi
  • addAuthScopes(scopeList)
  • containScopes(authId, scopeList)
  • getAuthResultWithScopes(scopeList)
  • getAuthResult

HuaweiIdAuthManager.getAuthApi()

返回帐号登录，静默登录，退出，取消授权接口

函数入参: 无

函数返回值:

示例代码:

import { HuaweiIdAuthManager} from 'hms-jsb-account'
var authApi =  HuaweiIdAuthManager.getAuthApi();

HuaweiIdAuthManager.addScopes(scopeList)

新增授权范围 Scope 列表并且后台静默登录

函数入参:

函数返回值: 无

示例代码:

import { HuaweiIdAuthManager, PROFILE} from 'hms-jsb-account'
var scopeList = new Array();
scopeList.push(PROFILE);
HuaweiIdAuthManager.addAuthScopes(scopeList);

HuaweiIdAuthManager.containScopes(authId, scopeList)

判断登录成功后返回帐号信息是否包含指定授权范围 Scope 列表

函数入参:

函数返回值：

示例代码:

import { HuaweiIdAuthManager, OPENID, PROFILE} from 'hms-jsb-account'
var scopeList = new Array();
scopeList.push(OPENID);
scopeList.push(PROFILE);
var isContained = HuaweiIdAuthManager.containScopes(null, scopeList);

HuaweiIdAuthManager.getAuthResultWithScopes(scopeList)

登录成功后返回的帐号信息中添加指定授权范围 Scope 列表

函数入参:

函数返回值:

示例代码:

import { HuaweiIdAuthManager, GAMES} from 'hms-jsb-account'
var scopeList = new Array();
scopeList.push(GAMES);
var authId = HuaweiIdAuthManager.getAuthResultWithScopes(scopeList);

HuaweiIdAuthManager.getAuthResult()

返回登录成功后缓存中的帐号信息

Kind: method method of HuaweiIdAuthManager

函数入参: 无

函数返回值:

示例代码:

import { HuaweiIdAuthManager} from 'hms-jsb-account'
HuaweiIdAuthManager.getAuthResult().then((result) => {
	console.info("getAuthResult success");
	console.info(JSON.stringify(result));
    this.getAuthResult = "getAuthResult success: " + JSON.stringify(result);
}).catch((error) => {
	console.info("getAuthResult fail:" + error);
    this.getAuthResult = "getAuthResult fail: " + error;
});

HuaweiIdAuth

account 对外导出登录，静默登录，退出，授权 JS API。推荐使用 HuaweiIdAuthManager.getAuthApi() 获取接口对象。然后调用相关接口。

Kind: global constant

• HuaweiIdAuth
  • getSignIntent(signInOption)
  • silentSignIn()
  • signOut()
  • cancelAuthorization()

HuaweiIdAuth.getSignIntent(signInOption)

前台帐号登录

函数入参:

函数返回值:

示例代码:

import { HuaweiIdAuthParamsHelper, HuaweiIdAuthManager } from 'hms-jsb-account'
var signInOption = new HuaweiIdAuthParamsHelper().setId().setProfile().setAuthorizationCode().build();
console.info(JSON.stringify(signInOption));
HuaweiIdAuthManager.getAuthApi().getSignInIntent(signInOption).then((result)=>{
	console.info("signIn success");
	console.info(JSON.stringify(result));
	this.signInResult = "signIn success: " + JSON.stringify(result);
}).catch((error)=>{
	console.error("signIn fail");
	console.error(JSON.stringify(error));
	this.signInResult = "signIn fail: " + JSON.stringify(error);
});

HuaweiIdAuth.silentSignIn()

后台帐号静默登录

函数入参: 可接收一个参数或者两个参数

函数返回值:

示例代码:

import { HuaweiIdAuthParamsHelper, HuaweiIdAuthManager, OPENID, PROFILE, HuaweiIdGetTokenOptions} from 'hms-jsb-account'
 
// case 1: one paramter
var signInOption = new HuaweiIdAuthParamsHelper().setId().setProfile().setIdToken().build();
console.error(JSON.stringify(signInOption));
HuaweiIdAuthManager.getAuthApi().silentSignIn(signInOption).then((result)=>{
	console.info("signIn success");
	console.info(JSON.stringify(result));
	this.signInResult = "signIn success: " + JSON.stringify(result);
}).catch((error)=>{
	console.error("signIn fail");
	console.error(JSON.stringify(error));
	this.signInResult = "signIn fail: " + JSON.stringify(error);
});

// case 2: two paramters
var signInOption = new HuaweiIdAuthParamsHelper().setId().setProfile().setIdToken().build();
console.error(JSON.stringify(signInOption));
// current login account name
var curAccountName = "xxxxxx";
var idTokenOption = new HuaweiIdGetTokenOptions(curAccountName, true);
HuaweiIdAuthManager.getAuthApi().silentSignIn(signInOption, idTokenOption).then((result)=>{
	console.info("signIn success");
	console.info(JSON.stringify(result));
	this.signInResult = "signIn success: " + JSON.stringify(result);
}).catch((error)=>{
	console.error("signIn fail");
	console.error(JSON.stringify(error));
	this.signInResult = "signIn fail: " + JSON.stringify(error);
});

HuaweiIdAuth.signOut()

帐号退出

函数入参: 无

函数返回值:

示例代码:

import { HuaweiIdAuthManager} from 'hms-jsb-account'
HuaweiIdAuthManager.getAuthApi().signOut().then((result)=>{
	console.info("signOut success");
	console.info(JSON.stringify(result));
	this.signOutResult = "signOut success: " + JSON.stringify(result);
}).catch((error) => {
	console.error("signout fail");
	console.error(JSON.stringify(error));
 	this.signOutResult = "signOut fail: " + JSON.stringify(error);
});

HuaweiIdAuth.cancelAuthorization()

帐号取消授权

函数入参: 无

函数返回值:

示例代码:

import { HuaweiIdAuthManager} from 'hms-jsb-account'
var signInOption = new HuaweiIdAuthParamsHelper().setId().setProfile().setAuthorizationCode().build();
console.error(JSON.stringify(signInOption));
HuaweiIdAuthManager.getAuthApi().cancelAuthorization(signInOption).then((result)=>{
	console.info("cancelAuthorization success");
	console.info(JSON.stringify(result));
	this.revokeAccessResult = "cancelAuthorization success: " + JSON.stringify(result);
}).catch((error) => {
	console.error("cancelAuthorization fail");
	console.error(JSON.stringify(error));
	this.revokeAccessResult = "cancelAuthorization fail: " + JSON.stringify(error);
});

• ForegroundManager
  • getForegroundApi

ForegroundManager.getForegroundApi()

返回帐号对外开放页面接口实现对象

函数入参: 无

函数返回值:

示例代码:

import { ForegroundManager} from '@hw-hmscore/hms-jsb-account'
var foregroundApi =  ForegroundManager.getForegroundApi();

• ForegroundApi
  • getForegroundIntent(path, params)

ForegroundApi.getForegroundIntent()

帐号前台开放页面

函数入参:

函数返回值:

示例代码:

import { ForegroundManager, ForegroundApis} from '@hw-hmscore/hms-jsb-account'
var params = {verifyToken:""}
ForegroundManager.getForegroundApi().getForegroundIntent(ForegroundApis.PATH_REALNAME_INFO, params).then((result)=>{
    //调用成功，返回对应信息
    console.info("getForegroundIntent success: " + result + "~~~~~~~~~");
    this.getForegroundIntentResult += "getForegroundIntent success: " + result + "~~~~~~~~~";
}).catch((error)=>{
    //调用失败
    console.error("getForegroundIntent fail: " + error + "~~~~~~~~~");
    this.getForegroundIntentResult += "getForegroundIntent fail: " + error + "~~~~~~~~~";
});