目录

AGConnectAuth

Class Info

public class AGConnectAuth extends Object

Auth SDK的入口类。

Public Method Summary

Qualifier and Type

Method Name and Description

public static AGConnectAuth

getInstance()

获取默认的AGConnectAuth实例。

public static AGConnectAuth

getInstance(AGConnectInstance instance)

获取指定AGConnectInstance对象的AGConnectAuth实例。

public abstract HarmonyTask<SignInResult>

signIn(AGConnectAuthCredential credential)

登录接口,通过第三方认证来登录HarmonyOS 开发者中心平台。

public abstract HarmonyTask<SignInResult>

signInAnonymously()

匿名登录。

public abstract HarmonyTask<Void>

deleteUser()

在AGC服务器侧删除当前用户信息,并清除缓存信息。

public abstract void

signOut()

登出接口。退出登录状态,删除缓存数据。

public abstract AGConnectUser

getCurrentUser()

获取当前登录的用户信息,如果未登录则返回null。

public abstract void

addTokenListener(OnTokenListener listener)

添加 token 变更监听,可以同时添加多个监听对象,监听回调在 UI 线程调用。

public abstract void

removeTokenListener(OnTokenListener listener)

移除 token 变更监听。

public abstract HarmonyTask<SignInResult>

createUser(EmailUser emailUser)

邮箱创建账户。

public abstract HarmonyTask<SignInResult>

createUser(PhoneUser phoneUser)

手机创建用户。

public abstract HarmonyTask<Void>

resetPassword(String email, String newPassword, String verifyCode)

通过邮箱重置用户密码。

public abstract HarmonyTask<Void>

resetPassword(String countryCode, String phoneNumber, String newPassword, String verifyCode);

通过手机重置用户密码。

public abstract HarmonyTask<VerifyCodeResult>

requestVerifyCode(String email, VerifyCodeSettings settings)

申请邮箱验证码。

public abstract HarmonyTask<VerifyCodeResult>

requestVerifyCode(String countryCode, String phoneNumber, VerifyCodeSettings settings)

申请手机验证码。

Public Methods

[h2]getInstance

Method

public static AGConnectAuth getInstance()

获取AGConnectAuth的实例。

[h2]getInstance

Method

public static AGConnectAuth getInstance(AGConnectInstance instance)

获取AGConnectAuth的实例。

Parameters

Name

Description

instance

AGConnectInstance对象(可以设置不同的存储位置等项目信息),您可以通过不同的AGConnectInstance的实例来获取不同的AGConnectAuth实例。

[h2]signIn

Method

public abstract HarmonyTask<SignInResult> signIn(AGConnectAuthCredential credential)

登录接口,通过第三方认证来登录HarmonyOS 开发者中心平台。

Parameters

Name

Description

credential

第三方OAuth2认证的凭证,需要通过对应的AuthProvider去创建。

Return

Type

Description

HarmonyTask<SignInResult>

登录异步调用结果。

[h2]signInAnonymously

Method

public abstract HarmonyTask<SignInResult> signInAnonymously()

匿名登录。

[h2]deleteUser

Method

public abstract HarmonyTask<Void> deleteUser()

在AGC服务器侧删除当前用户信息,并清除缓存信息。

Sample Code

AGConnectAuth.getInstance().deleteUser();

[h2]signOut

Method

public abstract void signOut()

登出接口。

退出登录状态,删除缓存数据。

[h2]getCurrentUser

Method

public abstract AGConnectUser getCurrentUser()

获取当前登录的用户信息,如果未登录则返回null。

Sample Code

AGConnectUser user = AGConnectAuth.getInstance().getCurrentUser();
if (user != null){
String id = user.getUid();
}

[h2]addTokenListener

Method

public abstract void addTokenListener(OnTokenListener listener)

添加token变更监听,可以同时添加多个监听对象,监听回调在UI线程调用。

Parameters

Name

Description

listener

监听者。

[h2]removeTokenListener

Method

public abstract void removeTokenListener(OnTokenListener listener)

移除token变更监听。

Parameters

Name

Description

listener

监听者。

[h2]createUser

Method

public abstract HarmonyTask<SignInResult> createUser(EmailUser emailUser)

邮箱创建账户。

Parameters

Name

Description

EmailUser

邮箱用户。

Return

Type

Description

HarmonyTask<SignInResult>

创建账户异步调用结果。

[h2]createUser

Method

public abstract HarmonyTask<SignInResult> createUser(PhoneUser phoneUser)

手机创建账户。

Parameters

Name

Description

PhoneUser

手机用户。

Return

Type

Description

HarmonyTask<SignInResult>

创建账户异步调用结果。

[h2]resetPassword

Method

public abstract HarmonyTask<Void> resetPassword(String email, String newPassword, String verifyCode)

通过邮箱重置用户密码。

Parameters

Name

Description

email

邮箱账号。

newPassword

新密码

verifyCode

验证码

Return

Type

Description

HarmonyTask<Void>

重置结果异步任务。

[h2]resetPassword

Method

public abstract HarmonyTask<Void> resetPassword(String countryCode, String phoneNumber, String newPassword,String verifyCode)

通过手机重置用户密码。

Parameters

Name

Description

countryCode

国家码。是指国际电话区号,例如中国为86,德国49,俄罗斯7,新加坡65。

本字段支持多种格式(以中国为例):86,+86。

phoneNumber

手机号。需要去掉“+”号和国家(地区)码,例如:+86132xxxxxxxx,则取值132xxxxxxxx。

newPassword

新密码。

verifyCode

验证码。

Return

Type

Description

HarmonyTask<Void>

重置结果异步任务。

[h2]requestVerifyCode

Method

public abstract HarmonyTask<VerifyCodeResult> requestVerifyCode(String email, VerifyCodeSettings settings)

申请邮箱验证码。

Parameters

Name

Description

email

邮箱。

settings

验证码的参数,验证码类型、语言、发送间隔等。

Return

Type

Description

HarmonyTask<VerifyCodeResult>

申请验证码的异步返回结果。

[h2]requestVerifyCode

Method

public abstract HarmonyTask<VerifyCodeResult> requestVerifyCode(String countryCode, String phoneNumber, VerifyCodeSettings settings)

申请手机验证码。

Parameters

Name

Description

countryCode

国家码。是指国际电话区号,例如中国为86,德国49,俄罗斯7,新加坡65。

本字段支持多种格式(以中国为例):86,+86。

phoneNumber

手机号。需要去掉“+”号和国家(地区)码,例如:+86132xxxxxxxx,则取值132xxxxxxxx。

settings

验证码的参数,验证码类型、语言、发送间隔等。

Return

Type

Description

HarmonyTask<VerifyCodeResult>

申请验证码的异步返回结果。