1.0.9 • Published 2 years ago
@hw-agconnect/auth-ohos v1.0.9
AGConnect 认证服务
简介
认证服务可以为您的应用快速构建安全可靠的用户认证系统,您只需在应用中访问认证服务的相关能力,而不需要关心云侧的设施和实现。
- 支持手机账号注册和登录。
- 支持邮箱账号注册和登录。
下载安装
ohpm install @hw-agconnect/auth-ohos
OpenHarmony ohpm 环境配置等更多内容,请参考如何安装 OpenHarmony ohpm 包
使用说明
import agconnect from "@hw-agconnect/api-ohos";
import "@hw-agconnect/core-ohos";
import "@hw-agconnect/auth-ohos";
需要权限
ohos.permission.INTERNET
使用示例
初始化
在您的项目中导入agc组件。
import agconnect from '@hw-agconnect/api-ohos'; import "@hw-agconnect/core-ohos"; import "@hw-agconnect/auth-ohos";
在您的应用初始化阶段使用context初始化SDK,推荐在MainAbility 的onCreate中进行。
//初始化SDK onCreate(want, launchParam) { //务必保证resources/rawfile中包含agconnect-services.json文件 agconnect.instance().init(this.context.getApplicationContext()); }
手机账号
申请手机号码注册的验证码。
调用AGConnectAuth.requestPhoneVerifyCode 申请验证码。
let verifyCodeSettings = new VerifyCodeSettingBuilder() .setAction(VerifyCodeAction.REGISTER_LOGIN) .setLang('zh_CN') .setSendInterval(60) .build(); agconnect.auth().requestPhoneVerifyCode(countryCode,phoneNumber,verifyCodeSettings);
使用手机号码注册用户。
调用PhoneUserBuilder生成PhoneUser,然后调用AGConnectAuth.createPhoneUser注册用户。注册成功后,系统会自动登录,无需再次调用登录接口。
let user = new PhoneUserBuilder() .setCountryCode("countryCode") .setPhoneNumber("phoneNumber") .setPassword("password") //可以给用户设置初始密码。填写后后续可以用密码来登录 .setVerifyCode('verifyCode') .build(); auth.createPhoneUser(user).then(result => {// 创建用户成功});
登录成功后可以调用AGConnectAuth.getCurrentUser获取用户帐号数据。
agconnect.auth().getCurrentUser();
邮箱账号
在使用邮箱注册之前,需要先验证您的邮箱,确保该邮箱帐户归您所有。
调用AGConnectAuth.requestEmailVerifyCode申请验证码。
let verifyCodeSettings = new VerifyCodeSettingBuilder() .setAction(VerifyCodeAction.REGISTER_LOGIN) .setLang('zh_CN') .setSendInterval(60) .build(); agconnect.auth().requestEmailVerifyCode('email',verifyCodeSettings);
使用邮箱帐号注册用户。
调用EmailUserBuilder生成EmailUser,然后调用AGConnectAuth.createEmailUser注册用户。注册成功后,系统会自动登录,无需再次调用登录接口。
let emailUser = new EmailUserBuilder() .setEmail("email") .setPassword("password") //可以给用户设置初始密码。填写后后续可以用密码来登录 .setVerifyCode("verifyCode") .build(); auth.createEmailUser(emailUser).then(result => {//创建帐号成功后,默认已登录})
登录成功后可以调用AGConnectAuth.getCurrentUser获取用户帐号数据。
agconnect.auth().getCurrentUser();
约束与限制
在下述版本验证通过: DevEco Studio: 3.1 Beta2(3.1.0.400), SDK: API9 Release(3.2.11.9)
License
auth-ohos sdk is licensed under the: "ISC"