文档管理中心

AuthAccount

  • 支持的场景:手机、平板、华为智慧屏、车机、智能手表。
  • 支持的OS:HarmonyOS 2.0及以上。
展开

Interface Info

public interface AuthAccount

登录的帐号信息,包含ID、显示名称、头像URI、权限等信息。

Public Method Summary

展开

Qualifier and Type

Method Name and Description

String

getDisplayName()

从帐号信息中获取昵称。

String

getEmail()

从帐号信息中获取Email。

String

getFamilyName()

从帐号信息中获取FamilyName。

String

getGivenName()

从帐号信息中获取GivenName。

Set<Scope>

getAuthorizedScopes()

从帐号信息中获取已经授权的Scope。

String

getIdToken()

从帐号信息中获取ID Token。

String

getAvatarUriString()

从帐号信息中获取头像URI。

String

getAuthorizationCode()

从帐号信息中获取授权码code。

String

getServiceCountryCode()

获取当前帐号所属的服务地国家。

String

getUnionId()

从帐号信息中获取UnionID

String

getOpenId()

从帐号信息中获取OpenID。

Public Methods

getServiceCountryCode

展开

Method

public String getServiceCountryCode()

获取当前帐号所属的服务地国家码。

Returns

展开

Type

Description

String

服务地国家码。

getDisplayName

展开

Method

public String getDisplayName()

如果授权时携带AccountAuthParamsHelpersetProfile方法指定的授权参数,该方法返回授权用户的帐号昵称,否则返回null。

Returns

展开

Type

Description

String

昵称。

getEmail

展开

Method

public String getEmail()

如果授权时携带AccountAuthParamsHelpersetEmail方法指定的授权参数,该方法返回授权用户的Email地址,否则返回null。

Returns

展开

Type

Description

String

帐号的Email地址。

getFamilyName

展开

Method

public String getFamilyName()

如果授权时携带AccountAuthParamsHelpersetProfile方法指定的授权参数,该方法返回授权用户的FamilyName,否则返回null。

Returns

展开

Type

Description

String

帐号的FamilyName。

getGivenName

展开

Method

public String getGivenName()

如果授权时携带AccountAuthParamsHelpersetProfile方法指定的授权参数,该方法返回授权用户的Given Name,否则返回null。

Returns

展开

Type

Description

String

帐号的GivenName。

getAuthorizedScopes

展开

Method

public Set<Scope> getAuthorizedScopes()

获取用户授权给当前应用的所有Scope或当前业务请求中传入的Scope

用户授权的Scope数量可能会比应用通过silentSignInsignIn请求获取的Scope数量多,建议业务按需授权。

  • 如果存在授权缓存信息,则获取用户授权给当前应用的所有Scope
  • 如果不存在授权缓存信息(调用signOut或者在应用管理中清除应用缓存),则获取当前业务请求中传入的Scope

Returns

展开

Type

Description

Set<Scope>

用户授权给当前应用的所有Scope

getIdToken

展开

Method

public String getIdToken()

如果授权时携带AccountAuthParamsHelpersetIdToken方法指定的授权参数,该方法返回授权用户的ID Token,否则返回null。

Returns

展开

Type

Description

String

返回授权用户的ID Token。

getAvatarUriString

展开

Method

public String getAvatarUriString()

如果授权时携带AccountAuthParamsHelper(AccountAuthParams.DEFAULT_AUTH_REQUEST_PARAM)或者setProfile方法指定的授权参数,该方法返回授权用户头像的URI地址,否则返回null。

Returns

展开

Type

Description

String

返回授权用户头像的URI地址。

getAuthorizationCode

展开

Method

public String getAuthorizationCode()

如果授权时携带setAuthorizationCode指定的授权参数,该方法返回用户的Authorization Code,否则返回null。应用可以使用Authorization Code从帐号服务器获取Access Token。

Returns

展开

Type

Description

String

返回用户的Authorization Code。

getUnionId

展开

Method

public String getUnionId()

如果授权时携带setId指定的授权参数,该方法返回用户的UnionID,否则返回null。

UnionID是用户在开发者多个应用中的唯一标志,对于同一个用户,同一个开发者帐号下管理的不同应用,UnionID值相同。如果一个应用转移到另外一个开发者帐号后,UnionID值也会变化。当前固定长度46,最大允许长度64,需进行三倍冗余考虑,不推荐进行长度限制。

UnionID和OpenID的区别在于,如果开发者帐号下管理了多个应用,针对同一个帐号,不同的应用返回的OpenID值不同,但返回的UnionID相同。如果您需要在不同应用中共享同一个帐号的用户信息,可以使用UnionID作为用户标识。

使用UnionID作为用户标识需要满足以下所有条件,如果任一不满足则不会返回:

  • HMS Core APK版本为4.0.4以及更高版本。
  • 应用启用了UnionID。

Returns

展开

Type

Description

String

获取用户的union ID。

getOpenId

展开

Method

public String getOpenId()

如果授权时携带setId指定的授权参数,该方法返回OpenID,否则返回null。

用户在应用中的唯一标识。同一个用户在不同应用下,OpenID值不同。使用OpenID标识用户,多个应用之间同一个帐号用户在开发者系统内会被标识为多个用户。当前非固定长度,最大允许长度256,需进行三倍冗余考虑,不推荐进行长度限制。

Returns

展开

Type

Description

String

获取用户的open ID。

在 API参考 中进行搜索
请输入您想要搜索的关键词