更新记录

1.5.0（2024-06-07） 下载此版本

修复iOS隐私协议弹窗异常问题

1.4.9（2024-06-05） 下载此版本

1.修复iOS缓存异常问题 2.修改Android授权页自定义图标方式 3.Android支持配置登录按钮左右边距 4.Android支持配置隐私区域宽度

1.4.8（2024-04-30） 下载此版本

1.授权页支持导航栏返回图标支持设置间距 2.授权页支持自定义协议未勾选弹窗文本颜色 3.授权页支持配置隐私协议连接符 4.授权页支持配置虚拟键区域是否显示

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

号码认证

网易易盾 提供直连三大运营商，一步校验手机号与当前 SIM 卡号一致性。优化注册/登录/支付等场景验证流程
了解更多产品信息或体验试用，请访问 号码认证产品页

更新提醒

• 在使用前请确保已申请到易盾一键登录的业务id
• 建议尽量用本地插件集成的方案，不要用云端插件，因为云端插件无法指定版本
• 从1.4.9版本开始，Android设置授权页自定义图标的方式有变更，请注意

平台支持（兼容性）

资源引入/集成

从 dcloud 插件市场下载对应插件放到指定目录 nativeplugins 下，也可以选择直接云端插件打包。导入插件之后一定要自定义基座方可生效，自定义基座说明请参考 https://ask.dcloud.net.cn/article/35115

调用示例

<template>
  <view>
    <button @click="initLogin('quickLogin')">初始化</button>
    <button @click="verifyNumber">授权验证</button>
  </view>
</template>

<script>
  const ydLogin = uni.requireNativePlugin('YD-Login')
  export default {
    methods: {
      initLogin() {
        // 初始化
        ydLogin.registerWithBusinessID({
          businessId: '从易盾获取业务id',
          timeout: 3000
        }, (data) => {
            // 回调处理
            if (data.success) {} else {}
        }),
      // 预取号
      verifyNumber(){
        ydLogin.getPhoneNumberCompletion((data) => {
          if (data.success) {
            // TODO: 预取号成功处理，可以进行调起授权页
            ydLogin.cucmctAuthorizeLoginCompletion((data) => {
              if (data.success) {
                // 授权成功
              }
            })
          }
        })
      }
    }
  }
</script>

更多使用场景请参考 demo

SDK 方法说明

在 nvue 中引入插件

const ydLogin = uni.requireNativePlugin('YD-Login')

1. 初始化

初始化一键登录

代码说明：

ydLogin.registerWithBusinessID({
  businessId: //'从易盾获取的id',
  loginType,
  timeout: 3000
}, (data) => {
  if (!data.success) {
    // TODO: 初始化失败处理
  } else {
    // TODO: 初始化成功处理，如进行下一步自定义授权页或直接进行预取号
  }
})

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  businessId	String	是	无	易盾分配的业务 id
  loginType	String	是	无	'quickLogin' 号码认证 或者 'quickPass' 本机校验
  debug	Boolean	否	false	是否打开日志开关
  timeout	int	否	3	运营商预取号和授权登录接口的超时时间，单位秒

• 回调参数说明：

  回调参数	类型	描述
  success	Boolean	初始化是否成功

2. 检查网络环境

检测网络状况等条件是否具备进行一键登录

代码说明：

ydLogin.shouldQuickLogin((data) => {
  if (!data.success) {
    // TODO: 具备一键登录网络环境
  } else {
    // TODO: 不具备一键登录网络环境
  }
})

参数说明：

• 回调参数说明：

  回调参数	类型	描述
  success	Boolean	是否具备一键登录网络环境

3. 预取号

代码说明：

ydLogin.getPhoneNumberCompletion((data) => {
  if (!data.success) {
    // TODO: 预取号失败处理
  } else {
    // TODO: 预取号成功处理，可以进行调起授权页
  }
})

参数说明：

• 回调参数说明：

  回调参数	类型	描述
  success	Boolean	预取号是否成功
  token	String	易盾token，用于校验
  msg	String	预取号异常信息，用于success返回false场景

4. 自定义授权页面

在工程目录下添加json配置文件，可配置项参考下面说明

代码说明：

ydLogin.setCustomView(config, (data) => {
  const platform = uni.getSystemInfoSync().platform
  if (platform === 'ios') {
    // TODO：iOS事件回调处理业务
  } else if (platform === 'android') {
    // TODO: android事件回调处理业务
  }
})

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  config	String	是	无	自定义配置项json字符串

config 可配置项说明： android版

开发者不得通过任何技术手段，将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖
网易易盾与运营商会对应用授权页面进行审查，若发现上述违规行为，网易易盾有权将您的一键登录功能下线
所有使用到的图标请放置在nativeResources/android/res/drawable目录下（命名只支持a-z、0-9和下划线），如果没有请在工程目录下创建，config配置文件中只配置图标的名字

状态栏

导航栏

应用 Logo

手机掩码

认证品牌

登录按钮

隐私协议

协议详情 Web 页面导航栏

其他

自定义view

config 可配置项说明： iOS版

设计规范概览 开发者不得通过任何技术手段，将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖
网易易盾与运营商会对应用授权页面进行审查，若发现上述违规行为，网易易盾有权将您的一键登录功能下线

基础配置

转场动画

自定义控件

"widgets": [
        {
           "type": "UIButton", 
           "UIButtonType": 0, 
           "image": "static/weixin.png",
           "title": "",    
           "titleColor": "#000000",
           "titleFont": 12,
           "cornerRadius": 20,
           "action": "handleCustomEvent1",
           "frame": {"mainScreenLeftDistance":100,"mainScreenTopDistance":360,"width":32,"height":32},
           "backgroundImage":"static/yidun_logo.png"
        },
        {
            "type": "UIButton",
            "UIButtonType": 0, 
            "image": "static/qq.png",
            "title": "",    
            "titleColor": "#FFFFFF",
            "titleFont": 12,
            "cornerRadius": 20,
            "action": "handleCustomEvent2",
            "frame": {"mainScreenCenterXWithLeftDistance":0,"mainScreenTopDistance":360,"width":32,"height":32},
            "backgroundImage": "static/yidun_logo.png"
        },
        {
            "type": "UIButton",
            "UIButtonType": 0, 
            "image": "static/weibo.png",
            "title": "",
            "titleColor": "#FFFFFF",
            "titleFont": 12,
            "cornerRadius": 20,
            "action": "handleCustomEvent3",
            "frame": {"mainScreenLeftDistance":100,"mainScreenRightDistance":360,"mainScreenTopDistance":32,"height":32},
            "backgroundImage": "static/yidun_logo.png"
        },
        {
            "type": "UILabel",
            "textColor": "#FFFFFF",
            "font": 15,
            "cornerRadius": 20,
            "action": "handleCustomLabel",
            "text": "其他登录方式",
            "textAlignment": 1,
            "frame": {"mainScreenLeftDistance":0,"mainScreenRightDistance":310,"mainScreenBottomDistance":200,"height":32}
        }
    ]

背景设置视频

背景设置 Gif

导航栏

应用 Logo

手机掩码

认证品牌

登录按钮

隐私协议

若勾选框需要展示，请务必设置勾选框的选中态图片与未选中态图片 协议未勾选时，登录按钮是否可点击可以自定义设置，弹窗提示的样式也可以自定义

弹窗模式

• 回调参数说明：

  callback -- 授权页事件回调（含生命周期钩子）
  
  // 返回参数
  // iOS版本
  data: {
  action: 事件名称、生命周期名称
  checked: 协议复选框值，仅在复选框事件和登录按钮点击事件中存在
  }
  
  // android版本
  data: {
  viewId: 自定义viewid
  lifecycle: 生命周期名称
  clickViewType: 内置组件事件触发目标
  isCheckboxChecked: 协议复选框的值，仅在复选框事件和登录按钮点击事件中存在
  }

  action值说明：

• iOS授权页生命周期action:

  • authViewDidLoad -- 加载授权页
  • authViewWillAppear -- 授权页已经出现
  • authViewWillDisappear -- 授权页将要消失
  • authViewDidDisappear -- 授权页已经消失
  • authViewDealloc -- 授权页销毁

• 页面默认组件点击事件action

  • loginAction -- 登录按钮点击事件（含checked: 0/1）
  • checkedAction -- 复选框事件（含checked: 0/1）
  • appDPrivacy -- 默认协议点击事件
  • appFPrivacy -- 第一个协议点击事件
  • appSPrivacy -- 第二个协议点击事件

lifecycle取值说明：

• onCreate -- 页面创建
• onStart -- 页面已开始活动
• onResume -- 页面展示
• onPause -- 页面非活动状态
• onStop -- 页面已停止
• onDestroy -- 页面销毁

clickViewType取值说明：

• privacy -- 隐私协议点击事件
• checkbox -- 复选框点击事件（含isCheckboxChecked: 0/1）
• loginButton -- 登录按钮点击事件（含isCheckboxChecked: 0/1）
• leftBackButton -- 左上角返回按钮点击事件

5. 调起授权页面

代码说明：

ydLogin.cucmctAuthorizeLoginCompletion((data) => {
  if (!data.success && !data.cancel) {
    // TODO: 授权失败处理
  } else if (data.cancel) {
    // TODO: 用户主动取消授权处理
  } else {
    // TODO: 授权成功处理，可以进行关闭授权页、服务端验证等
  }
})

参数说明：

• 回调参数说明：

  回调参数	类型	描述
  success	Boolean	授权是否成功
  cancel	Boolean	用户是否主动取消授权（android独有）
  accessToken	String	授权token

6. 自动登录

注意：该方法仅限iOS

代码说明：

ydLogin.authLoginButtonClick()

7. 设置协议复选框

代码说明：

ydLogin.checkedSelected(checked)

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  checked	Boolean	是	无	true:复选框勾选，false:复选框取消勾选

8. 清除缓存

注意：该方法仅限Android

代码说明：

ydLogin.clearScripCache()

9. 关闭授权页

插件内部不会主动关闭授权页，请在cucmctAuthorizeLoginCompletion回调中主动调用该函数关闭

代码说明：

ydLogin.closeAuthController()

10. 本机校验

用户输入手机号码后，自动校验与当前本机卡号的一致性，无需发送短信验证码

代码说明：

  ydLogin.numberVerify(mobileNumber, (data) => {
    if (data && data.success) {
        console.log(data.token, data.accessCode)
    } else {
        console.log(data.token, data.errorMsg)
    }
  })

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  mobileNumber	String	是	无	手机号

• 回调参数说明：

  回调参数	类型	描述
  success	Boolean	调用是否成功
  token	String	易盾 token
  accessCode	String	运营商授权码
  errorMsg	String	出现错误时返回错误详情