目录

AuthUser

当前登录的用户信息。

Method Summary

Qualifier and Type

Method Name and Description

string

getUid()

获取用户ID,此ID由HarmonyOS 开发者中心生成。

string

getEmail()

获取用户邮箱。

string

getPhone()

获取用户手机号码。

string

getDisplayName()

获取用户名称。

string

getPhotoUrl()

获取用户头像。

string

getProviderId()

获取当前用户的提供者,第三方认证平台的名称。

Array<Map<String, String>>

getProviderInfo()

获取全部第三方平台的用户信息。

Promise<TokenResult>

getToken(forceRefresh: boolean)

获取已登录HarmonyOS 开发者中心用户的Access Token信息。

Promise<AuthUserExtra>

getUserExtra()

获取当前用户的Extra信息。

boolean

isAnonymous()

是否是匿名登录用户。

boolean

getEmailVerified()

获取邮箱验证标记。

boolean

getPasswordSetted()

获取密码设置标记。

Promise<SignInResult>

link(credentialInfo: CredentialInfo)

当前用户关联新的登录方式。

Promise<SignInResult>

unlink(type: ProviderType)

当前用户解除关联的登录方式。

Promise<void>

updateEmail(emailInfo: EmailInfo)

更新当前用户邮箱。

Promise<void>

updatePhone(phoneInfo: PhoneInfo)

更新当前用户手机号码。

Promise<void>

updatePassword(passwordInfo: PasswordInfo)

更新当前用户密码。

Promise<void>

updateProfile(userProfile: UserProfileInfo)

更新当前用户的个人信息。

Promise<SignInResult>

userReauthenticate(signInParam: SignInParam)

用户登录后重认证。

Methods

[h2]getUid

Method

getUid():string

获取用户ID,此ID由HarmonyOS 开发者中心平台生成。

Return

Type

Description

string

用户ID。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let uid = user.getUid();
  }
})

[h2]getEmail

Method

getEmail():string

获取用户邮箱地址。

Return

Type

Description

string

用户Email。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let email = user.getEmail();
  }
})

[h2]getPhone

Method

getPhone():string

获取用户手机号码。

Return

Type

Description

string

用户手机号码。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let phone = user.getPhone();
  }
})

[h2]getDisplayName

Method

getDisplayName():string

获取用户名称。

Return

Type

Description

string

用户名称。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let phone = user.getDisplayName();
  }
})

[h2]getPhotoUrl

Method

getPhotoUrl():string

获取用户头像的url。

Return

Type

Description

string

用户头像的url。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let phone = user.getPhotoUrl();
  }
})

[h2]getProviderId

Method

getProviderId():string

获取当前用户的提供者,即第三方认证平台的名称。

Return

Type

Description

string

用户的提供者。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let providerId = user.getProviderId();
  }
})

[h2]getProviderInfo

Method

getProviderInfo():Array<Map<String, String>>

获取全部第三方平台的用户信息。

Return

Type

Description

Array<Map<String, String>>

当前登录的各个第三方认证平台用户信息的列表。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let providerInfo = user.getProviderInfo();
  }
})

[h2]getToken

Method

getToken(forceRefresh:boolean):Promise<TokenResult>

获取已登录HarmonyOS 开发者中心用户的Access Token信息。

Parameters

Name

Type

Description

forceRefresh

boolean

可选,默认为false。是否强制刷新Access Token。

Return

Type

Description

Promise<TokenResult>

已登录HarmonyOS 开发者中心用户的Access Token信息的Promise对象。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then((user) => {
  if(user){
    user.getToken(false).then(tokenResult => {
      console.log(`accessToken:${tokenResult.getString()} ExpirePeriod:${tokenResult.getExpirePeriod()}`);
    })
  }
})

[h2]getUserExtra

Method

getUserExtra():Promise<AuthUserExtra>

获取当前用户的Extra信息。

Return

Type

Description

Promise<AuthUserExtra>

用户的Extra信息的Promise对象。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let userExtra = user.getUserExtra();
  }
})

[h2]isAnonymous

Method

isAnonymous():boolean

是否是匿名登录用户。

Return

Type

Description

boolean

是否是匿名用户。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let isAnonymous = user.isAnonymous();
  }
})

[h2]getEmailVerified

Method

getEmailVerified():boolean

获取邮箱认证标记。

Return

Type

Description

boolean

邮箱验证标记。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let emailVerified = user.getEmailVerified();
  }
})

[h2]getPasswordSetted

Method

getPasswordSetted():boolean

获取密码设置标记。

Return

Type

Description

boolean

密码设置标记。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user=>{
  if(user){
    let passwordSetted = user.getPasswordSetted();
  }
})

[h2]link

Method

link(credentialInfo: CredentialInfo): Promise<SignInResult>

当前用户关联新的登录方式。

此接口会验证用户Access Token和Refresh Token,请确保用户Refresh Token在有效期内,否则会抛出错误码203817986,表示用户Refresh Token无效。

收到此错误码后,请重新登录应用,获取新的Access Token和Refresh Token。

Parameters

Name

Type

Description

credentialInfo

CredentialInfo

必选,凭证信息。编译器会根据其中kind自动推断类型,例如其内部kind填为:'phone',则类型被推断为“PhoneCredentialInfo”。

Return

Type

Description

Promise<SignInResult>

登录结果信息的Promise对象。

若您在注册或登录时使用了密码,则调用link()接口时无需再传入password字段,否则会导致关联失败。

Sample Code

import auth from '@hw-agconnect/auth';

// 关联新的email账户
auth.getCurrentUser().then(user => {
  if(user){
    user.link({
      kind: 'email',
      password: '123456',
      email: 'yyyy@xxxx.com',
      verifyCode: 'xxxxxx'
    });
  }
});

// 关联新的手机账户
auth.getCurrentUser().then(user => {
  if(user){
    user.link({
      kind: 'phone',
      phoneNumber: '138********',
      countryCode: '86',
      verifyCode: 'xxxxxx'
    });
  }
});

[h2]unlink

Method

unlink(type: ProviderType): Promise<SignInResult>

当前用户解除已关联的登录方式。

此接口会验证用户Access Token和Refresh Token,请确保用户Refresh Token在有效期内,否则会抛出错误码203817986,表示用户Refresh Token无效错误码。

收到此错误码后,请重新登录应用,获取新的Access Token和Refresh Token。

Parameters

Name

Type

Description

type

ProviderType

必选,渠道类型支持'email' 、 'phone' 、 'hwid' 或 'selfBuild'。

Return

Type

Description

Promise<SignInResult>

登录结果信息的Promise对象。

Sample Code

import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user => {
  if(user){
    user.unlink('phone');
  }
});

[h2]updateEmail

Method

updateEmail(emailInfo: EmailInfo): Promise<void>

用户邮箱登录后,更新用户邮箱地址。

Parameters

Name

Type

Description

emailInfo

EmailInfo

Email账号信息类。

Return

Type

Description

Promise<void>

void类型的Promise对象。

Sample Code
import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then((user) => {
  if(user){
    user.updateEmail({
      email: 'xxxx@xxx.com',
      lang: 'zh_CN',
      verifyCode: 'xxxxxx'
    })
  }
})

[h2]updatePhone

Method

updatePhone(phoneInfo: PhoneInfo): Promise<void>

用户手机登录后,更新用户手机号码。

Parameters

Name

Type

Description

phoneInfo

PhoneInfo

必选,手机号码信息类。

Return

Type

Description

Promise<void>

void类型的Promise对象。

Sample Code
import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then((user) => {
  if(user){
    user.updatePhone({
      countryCode: '86',
      phoneNumber: '138********',
      verifyCode: 'xxxxxx',
      lang: 'zh_CN'
    })
  }
})

[h2]updatePassword

Method

updatePassword(passwordInfo: PasswordInfo): Promise<void>

更新当前用户密码。

Parameters

Name

Type

Description

passwordInfo

PasswordInfo

必选,更新密码操作相关的密码信息类。

Return

Type

Description

Promise<void>

void类型的Promise对象。

Sample Code
import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then((user) => {
  if(user){
    user.updatePassword({
      password: '123456',
      verifyCode: 'xxxxxx',
      providerType: 'phone'
    })
  }
})

[h2]updateProfile

Method

updateProfile(userProfile: UserProfileInfo): Promise<void>

更新当前用户的个人信息。

Parameters

Name

Type

Description

userProfile

UserProfileInfo

必选,个人账户信息类。

Return

Type

Description

Promise<void>

void类型的Promise对象。

Sample Code
import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user => {
  if(user){
    user.updateProfile({
      photoUrl: 'https://xxx.png',
      displayName: 'HamonyOSUser'
    })
  }
})

[h2]userReauthenticate

Method

userReauthenticate(signInParam: SignInParam): Promise<SignInResult>

用户登录后重认证。

Parameters

Name

Type

Description

signInParam

SignInParam

必选,登录操作的参数类。

Return

Type

Description

Promise<SignInResult>

登录结果信息的Promise对象。

Sample Code
import auth from '@hw-agconnect/auth';

auth.getCurrentUser().then(user => {
  if (!user) {
    return;
  }
  user.userReauthenticate({
    credentialInfo: {
      kind: 'phone',
      password: '123456',
      phoneNumber: '138********',
      countryCode: '86',
      verifyCode: 'xxxxxx'
    }
  });
});