更新记录

1.0.2（2020-09-02）

1、添加一键登录功能 2、添加本机号码校验功能

平台兼容性

原生插件通用使用流程：

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原生插件配置”->”云端插件“列表中删除该插件重新选择

创建应用

引用方式

var OXSDKModule = uni.requireNativePlugin("OX-OneKeyModule");

Android部分

一、免密登录API

1. 初始化

使用一键登录功能前，必须先进行初始化操作。 app_id、app_secret请在秒验平台my.wlwx.com中注册账号，并创建应用，获取app_id和app_secret

使用示例

OXSDKModule.init({
        'app_id': app_id,
        'app_secret': app_secret,
        'timeout': 5
        },
        (result) => {
            this.ox_code = result.result.code;
            this.ox_result = JSON.stringify(result);
            let status = '';
            if(this.ox_code =='00000'){
              status = '成功';
              this.init_state = true;
            }else{
              status = '失败';
            }
});

参数描述

返回参数

1. 预取号

建议在拉取授权页之前提前调用此方法，加快授权页的拉取；提高用户体验

使用示例

OXSDKModule.preLogin(
    (result) => {   
            this.ox_code = result.result.code;
            this.ox_result = JSON.stringify(result);
            let status = '';
            if(this.ox_code =='00000'){
                status = '成功';
            }else{
                status = '失败';
            }
});

返回参数

1. 拉起授权页

   如需自定义授权页，请在拉取授权页之前调用设置授权页风格的方法

使用示例

OXSDKModule.oneKeyLogin(
    (result) => {
        this.ox_code = result.result.code;
        this.ox_result = JSON.stringify(result);
        let status = '';
        if(this.ox_code =='00000'){
            status = '成功';
        }else if(this.ox_code =='45009'){
            status = '取消登录';
        }else if(this.ox_code =='45033'){
            status = '调起授权页';
        }else{
            status = '失败';
        }
});

返回参数

1. 置换手机号

****将一键登录获取到的access_token传予后台，置换当前的手机号码；详细使用参见Demo

1. 授权页界面配置

****通过此方法，用户可更改授权页的界面风格；须在拉起授权页之前，初始化之后调用；

使用示例

OXSDKModule.setAuthTheme({
        'authWindowModel': 1, // 窗口模式 0全屏 1窗口
        // 'navColor': "#FFFFFF", // 导航栏颜色 - 窗口模式下无
        'navText': "测试标题", // 导航标题
        'navTextColor': "#000000", // 导航栏文字颜色
        'logoImgResName': "static/logo.png", // 授权页Logo
        'loginBtnBackgroundResName': "#1E90FF", //  登录按钮颜色
        'loginBtnBackgroundRadius' : 20,    // 登录按钮圆角－０或不传则代表无圆角
        'checkBoxCheckedButtonResName': "static/check_box_checked.png", // 复选框选中图片
        'checkBoxUnCheckedButtonResName': "static/check_box_uncheck.png", // 复选框图片
        'dialogWindowBgResName': "#FFFFFF", // 授权页颜色-弹窗
        'clausePageBackImgResName': "static/back.png", // 协议预览页返回键图标资源
        'navReturnImgResName': "static/back.png", // 导航栏返回按钮图标
        'logoFrames': {
            'width': 70,
            'height': 70
        }, // 授权LOGO宽高
        'logoHidden': false, // 授权LOGO是否隐藏
        'numberColor': "#000000", // 授权页号码颜色
        'numberSize': 25, // 授权页号码文本字体大小
        'sloganTextColor': "#001100", // 授权页slogan颜色
        'sloganTextSize': 16, // 授权页slogan文本字体大小
        'loginBtnText': "本机号码一键登录", // 授权页登录按钮文本
        'loginBtnTextSize': 18, //  授权页登录按钮文本字体大小
        'loginBtnTextColor': "#FFFFFF", //  授权页登录按钮文本颜色
        'clause': {
            'clauseTextFormat': "登录即表明同意%s和%s<br>以及?",
            'ag1': {
                'title': '用户协议',
                'url': 'https://www.baidu.com',
                },
            'ag2': {
                title': '隐私政策',
                'url': 'https://www.baidu.com',
            },
        },
        'clauseColor': {
                'first': "#000000",
                'second': "#1E90FF"
        }, // 协议文本字体颜色
        'privacyState': true, // 复选框选中状态
        'privacyTextSize': 10, // 协议文本字体大小
        'privacyCheckBoxHidden': false, // 协议勾选框显隐
        'clausePageBackImgAlignParentLeft': true,
        'clausePageNavColor': "#2459eb", // 协议预览页导航颜色
        'clausePageNavTextColor': "#2459eb", // 协议预览页导航文字颜色
        'clausePageBackImgParams': {
                'width': 50,
                'height': 50
        }, // 修改条款预览页返回按钮大小
        'operatorTermsPunctuationMarks': false, // 设置运营商协议是否有书名号，默认true
        'customViews': {
            'widget1': {
                'widgetId': "customView_one",
                'type': "TextView",
                'top': 15,
                'left': 15,
                'width': 60,
                'height': 30,
                'textContent': "设置",
                'textFont': 13,
                'textColor': "#2459eb",
                'backgroundColor': ""
            },
        } // 自定义的授权页view
    }, (ret) => {

});

授权页具体配置说明：

自定义View部分，只支持TextView以及ImageView；且全屏、弹窗不同模式下对应参数也有所变动。

'widget1': {
    'widgetId': "customView_one",
    'type': "TextView",
    'top':10,
    'bottom': 10,
    'width': 80,
    'height': 30,
    'textContent': "自定义控件1",
    'textFont': 13,
    'textColor': "#000000",
    'backgroundColor': "#ffffff"
},
 'widget2': {
    'widgetId': "customView_two",
    'type': "ImageView",
    'top': 15,
    'left': 15,
    'width': 60,
    'height': 60,
    'backgroundImagePath': "static/logo.png"
}

注意：

1.窗口模式：只有top、left属性生效；靠这两个参数即确定view的位置，相对弹窗的主体内容的偏移量；

2.全屏模式：只有top、bottom属性生效，因为默认布局中内容全为水平居中；

3.所有的图片资源都需放置于static目录下；

1. 销毁授权页

调用此方法，可手动关闭授权页；

使用示例

OXSDKModule.finish();

1. 自定义View点击回调

****通过第五点进行自定义View的用户可通过此方法设置自定义View的点击事件；建议在初始化后调用

使用示例

OXSDKModule.setDelegate(
    (ret) => {
    }
);

返回参数

二、本机号校验

与免密登录一致，都需要在初始化的前提下才能使用

1. 初始化

同免密登录初始化

1. 获取本机号token

不提供对应的界面，自行实现

使用示例

OXSDKModule.getToken(
    (result) => {
        this.ox_code = result.result.code;
        this.ox_result = JSON.stringify(result);
        let status = '';
        if(this.ox_code =='00000'){
            status = '成功';
        }else{
            status = '失败';
        }
});

返回参数

1. 本机号token校验

根据第二步获取的access_token，与服务端进行token校验；详细参见Demo

三、其他

1. 获取设备网络

获取设备当前的网络类型等信息

使用示例

OXSDKModule.getNetworkType(
    (ret) => {
        var code = ret['code'];         
        this.ox_result = ret['networkType'];
    }
);

返回参数

ios部分

一、免密登录API

1. 初始化

使用一键登录功能前，必须先进行初始化操作。

使用示例

OXSDKModule.init({
    'app_id':app_id,
    'app_secret':app_secret，
    'timeout':5 
},result => { 
    this.ox_code = result.result.code;
    this.ox_result = JSON.stringify(result);
    let status = '';
    if(this.ox_code =='00000'){
        status = '成功';
        this.init_statue = true;
    }else{
        status = '失败';
    }
});

参数描述

返回参数

1. 预取号

建议在拉取授权页之前提前调用此方法，加快授权页的拉取；提高用户体验

使用示例

OXSDKModule.preLoging({
    'timeout':5 //超时时间 默认5秒
},result => { 
    this.ox_code = result.result.code;
    this.ox_result = JSON.stringify(result);
    let status = '';
    if(this.ox_code =='00000'){
        status = '成功';
    }else{
        status = '失败';
    }
});

返回参数

1. 拉起授权页

   如需自定义授权页，请在拉取授权页之前调用设置授权页风格的方法

使用示例

OXSDKModule.onekeyLogin({
    'timeout':5 //超时时间 
},result => { 
    this.ox_code = result.result.code;
    this.ox_result = JSON.stringify(result);
    let status = '';
    if(this.ox_code =='00000'){
        status = '成功';
    }else if(this.ox_code =='45009'){
        status = '取消登录';
    }else if(this.ox_code =='45033'){
        status = '调起授权页';
    }else{
        status = '失败';
    }
});

1. 置换手机号

****将一键登录获取到的access_token传予后台，置换当前的手机号码；详细使用参见Demo

1. 授权页界面配置

****通过此方法，用户可更改授权页的界面风格；须在拉起授权页之前，初始化之后、拉起授权页前调用；

OXSDKModule.setOneKeyModelConfig(this.ios_uiConfigure);

授权页具体配置说明： 功能开关

弹窗设置

背景

状态栏

导航栏

LOGO

手机号

登录按钮

条款选择框

隐私条款

协议页

运营商标识

Loading

toast视图

横竖屏设置

授权页布局

OXOrientationLayOut布局设置

LOGO

手机号

slogan

登录按钮

隐私条款

弹窗协议页

自定义控件

使用示例

setAuthDialogThemeConfig(){
  let screenWidth_Portrait = plus.screen.resolutionWidth; //竖屏宽
  let screenHeight_Portrait = plus.screen.resolutionHeight; //竖屏高
  let screenWidth_Landscape = plus.screen.resolutionHeight; //横屏宽(即竖屏高)
  let screenHeight_Landscape = plus.screen.resolutionWidth; //横屏高(即竖屏宽)                 
  var screenScale = screenWidth_Portrait / 375.0; //相对iphone6屏幕
  if (screenScale > 1) {
    screenScale = 1; //大屏的无需放大
  }
  let oxAuthWindowOrientationWidth_Portrait = screenScale*299;
  let oxAuthWindowOrientationHeight_Portrait = screenScale*363;
  let oxAuthWindowOrientationCenter_Portrait = [screenWidth_Portrait * 0.5, screenHeight_Portrait * 0.5];

   /**竖屏*/
  /**LOGO图片*/
  let oxLayoutLogoTop_Portrait = 10;
  let oxLayoutLogoWidth_Portrait = screenScale*55;
  let oxLayoutLogoHeight_Portrait = screenScale*55;
  let oxLayoutLogoCenterX_Portrait = 0;
  /**手机号显示控件*/
  let oxLayoutPhoneTop_Portrait = screenScale*65;
  let oxLayoutPhoneWidth_Portrait = 200;
  let oxLayoutPhoneHeight_Portrait = 40;
  let oxLayoutPhoneCenterX_Portrait = 0;
  /*登录按钮*/
  let oxLayoutLoginBtnTop_Portrait = screenScale*110;
  let oxLayoutLoginBtnWidth_Portrait = screenScale*250;
  let oxLayoutLoginBtnHeight_Portrait = screenScale*36;
  let oxLayoutLoginBtnCenterX_Portrait = 0;                 
  /*Slogan*/
  let oxLayoutSloganTop_Portrait = screenScale*146+36+2;
  let oxLayoutSloganWidth_Portrait = 300;
  let oxLayoutSloganHeight_Portrait = 40;
  let oxLayoutSloganCenterX_Portrait = 0;
  /*隐私条款*/
  let oxLayoutAppTermsBottom_Portrait = -20;
  let oxLayoutAppTermsCenterX_Portrait = 10;
  let oxLayoutAppTermsWidth_Portrait = screenScale*210;
  let oxLayoutAppTermsHeight_Portrait = 50;

  //横屏
  let oxAuthWindowOrientationWidth_Landscape = screenScale*363;
  let oxAuthWindowOrientationHeight_Landscape = screenScale*226;
  let oxAuthWindowOrientationCenter_Landscape = [screenWidth_Landscape * 0.5, screenHeight_Landscape * 0.5];
  /**LOGO图片*/
  let oxLayoutLogoLeft_Landscape = screenScale*80;
  let oxLayoutLogoTop_Landscape = 1;
  let oxLayoutLogoWidth_Landscape = screenScale*55;
  let oxLayoutLogoHeight_Landscape = screenScale*55;
  /**手机号显示控件*/
  let oxLayoutPhoneLeft_Landscape = screenScale*110;
  let oxLayoutPhoneTop_Landscape = 1;
  let oxLayoutPhoneWidth_Landscape = 200;
  let oxLayoutPhoneHeight_Landscape = 40;
  /*登录按钮*/
  let oxLayoutLoginBtnTop_Landscape = screenScale*80;
  let oxLayoutLoginBtnWidth_Landscape = screenScale*300;
  let oxLayoutLoginBtnHeight_Landscape = 40;
  let oxLayoutLoginBtnCenterX_Landscape = 0;
  /*Slogan*/
  let oxLayoutSloganLeft_Landscape = screenScale*120;
  let oxLayoutSloganTop_Landscape = 30;
  let oxLayoutSloganWidth_Landscape = 200;
  let oxLayoutSloganHeight_Landscape = 40;
  /*隐私条款*/
  let oxLayoutAppTermsTop_Landscape = screenScale*85+40+13;
  //    let oxLayoutAppTermsLeft_Landscape = 10;
  //    let oxLayoutAppTermsBottom_Landscape = -5;
  let oxLayoutAppTermsWidth_Landscape = screenScale*270;
  //    let oxLayoutAppTermsHeight_Landscape = 50;
  let oxLayoutAppTermsCenterX_Landscape = 10;

  this.ios_uiConfigure = {
    oxNavigationBackgroundoxear:true,
    oxLogoImage:"static/logo.png",
    oxCheckBoxCheckedImage:"static/icon-gx2.png",
    oxCheckBoxUncheckedImage:"static/icon-bgx2.png",
    oxPhoneNumberFont:15,
    oxLoginBtnCornerRadius:2,
    oxLoginBtnBgColor:[92,140,248,1],
    oxAuthTypeUseWindow:true,
    oxShouldAutorotate: true,
    oxAppTermsPunctuationMarks: true,
    oxPhoneNumberColor:[20,20,24,1],
    oxSloganTextColor:[87,98,122,1],
    oxAppTermsColor:[[57,108,245,1],[87,98,122,1]],
    oxCheckBoxValue:true,
    oxTermsTemplate:['登录即同意&&默认&&和《百度》、《网易》并使用本机号码登录',12,[0.2, 0.8, 0.2, 1.0]],
    oxTerms:[['《百度》','https://www.baidu.com'],['《网易》','https://www.baidu.com']],
    oxOrientationLayOutPortrait:{
        oxAuthWindowOrientationWidth : oxAuthWindowOrientationWidth_Portrait,
        oxAuthWindowOrientationHeight : oxAuthWindowOrientationHeight_Portrait,
        oxAuthWindowOrientationCenter : oxAuthWindowOrientationCenter_Portrait,
        /**LOGO图片*/
        oxLayoutLogoTop : oxLayoutLogoTop_Portrait,
        oxLayoutLogoWidth : oxLayoutLogoWidth_Portrait,
        oxLayoutLogoHeight : oxLayoutLogoHeight_Portrait,
        oxLayoutLogoCenterX : oxLayoutLogoCenterX_Portrait,
        /**手机号显示控件*/
        oxLayoutPhoneTop : oxLayoutPhoneTop_Portrait,
        oxLayoutPhoneWidth : oxLayoutPhoneWidth_Portrait,
        oxLayoutPhoneHeight : oxLayoutPhoneHeight_Portrait,
        oxLayoutPhoneCenterX : oxLayoutPhoneCenterX_Portrait,
        /*登录按钮*/
        oxLayoutLoginBtnTop : oxLayoutLoginBtnTop_Portrait,
        oxLayoutLoginBtnWidth : oxLayoutLoginBtnWidth_Portrait,
        oxLayoutLoginBtnHeight : oxLayoutLoginBtnHeight_Portrait,
        oxLayoutLoginBtnCenterX : oxLayoutLoginBtnCenterX_Portrait,                 
        /*Slogan*/
        oxLayoutSloganTop : oxLayoutSloganTop_Portrait,
        oxLayoutSloganWidth : oxLayoutSloganWidth_Portrait,
        oxLayoutSloganHeight : oxLayoutSloganHeight_Portrait,
        oxLayoutSloganCenterX : oxLayoutSloganCenterX_Portrait,
        /*隐私条款*/
        // oxLayoutAppTermsBottom : oxLayoutAppTermsBottom_Portrait,
        oxLayoutAppTermsBottom : oxLayoutAppTermsBottom_Portrait,
        oxLayoutAppTermsCenterX : oxLayoutAppTermsCenterX_Portrait,
        oxLayoutAppTermsWidth : oxLayoutAppTermsWidth_Portrait,
        oxLayoutAppTermsHeight : oxLayoutAppTermsHeight_Portrait,
    },
    //横屏布局对象
    oxOrientationLayOutLandscape: {
        oxAuthWindowOrientationWidth : oxAuthWindowOrientationWidth_Landscape,
        oxAuthWindowOrientationHeight : oxAuthWindowOrientationHeight_Landscape,
        oxAuthWindowOrientationCenter : oxAuthWindowOrientationCenter_Landscape,
        /**LOGO图片*/
        oxLayoutLogoLeft : oxLayoutLogoLeft_Landscape,
        oxLayoutLogoTop : oxLayoutLogoTop_Landscape,
        oxLayoutLogoWidth : oxLayoutLogoWidth_Landscape,
        oxLayoutLogoHeight : oxLayoutLogoHeight_Landscape,
        /**手机号显示控件*/
        oxLayoutPhoneLeft : oxLayoutPhoneLeft_Landscape,
        oxLayoutPhoneTop : oxLayoutPhoneTop_Landscape,
        oxLayoutPhoneWidth : oxLayoutPhoneWidth_Landscape,
        oxLayoutPhoneHeight : oxLayoutPhoneHeight_Landscape,
        /*登录按钮*/
        oxLayoutLoginBtnTop : oxLayoutLoginBtnTop_Landscape,
        oxLayoutLoginBtnWidth : oxLayoutLoginBtnWidth_Landscape,
        oxLayoutLoginBtnHeight : oxLayoutLoginBtnHeight_Landscape,
        oxLayoutLoginBtnCenterX : oxLayoutLoginBtnCenterX_Landscape,
        /*Slogan*/
        oxLayoutSloganLeft : oxLayoutSloganLeft_Landscape,
        oxLayoutSloganTop : oxLayoutSloganTop_Landscape,
        oxLayoutSloganWidth : oxLayoutSloganWidth_Landscape,
        oxLayoutSloganHeight : oxLayoutSloganHeight_Landscape,
        /*隐私条款*/
        oxLayoutAppTermsTop : oxLayoutAppTermsTop_Landscape,
    //    let oxLayoutAppTermsLeft_Landscape,
    //    let oxLayoutAppTermsBottom_Landscape,
        oxLayoutAppTermsWidth : oxLayoutAppTermsWidth_Landscape,
    //    let oxLayoutAppTermsHeight_Landscape,
        oxLayoutAppTermsCenterX : oxLayoutAppTermsCenterX_Landscape
    },
    //自定义控件
    widgets: {
        widget0: {
            widgetId: "customView_one", //字符标记
            navPosition: "navright",
            type: "Button", // 类型：Button：按钮，ImageView:图片 TextView:文本
            textContent: "设置",//文字
            textColor: [87,98,122,1],//文字颜色[r,g,b,a]
            portraitFrame:[0,0,40,40],
            isFinish: true,
        },
        widget1: {
            widgetId: "customView_two", //字符标记
            type: "Button", // 类型：Button：按钮，ImageView:图片 TextView:文本
            textContent: "其它方式登录",//文字
            textColor: [87,98,122,1],//文字颜色[r,g,b,a]
            backgroundColor:[92,140,248,1],
            cornerRadius:2,
            portraitFrame:[screenScale*(299-250)/2,screenScale*110+44+40+2,screenScale*250,36],
            landscapeFrame:[screenScale*(363-300)/2,screenScale*80+44+40+2,screenScale*300,36],
        },
    },
  },
  //设置自定义控件点击回调
  OXSDKModule.setCustomInterface((customInterface) => { 
    this.ox_result = JSON.stringify(customInterface);
  });
  //设置授权页样式                     OXSDKModule.setOneKeyModelConfig(this.ios_uiConfigure);
},

6.自定义View点击回调

****通过第五点进行自定义View的用户可通过此方法设置自定义View的点击事件；建议在初始化后调用

使用示例

OXSDKModule.setCustomInterface((customInterface) => {   
    this.ox_result = JSON.stringify(customInterface);
});

返回参数

7.销毁授权页

调用此方法，可手动关闭授权页；

使用示例

OXSDKModule.dismissLoginPage({
  'flag':true //dismiss动画状态 
},result => { 
    //销毁完成
});

二、本机号校验

与免密登录一致，都需要在初始化的前提下才能使用

1. 初始化

同免密登录初始化

1. 获取本机号token

不提供对应的界面，自行实现

使用示例

OXSDKModule.checkPhoneNumber({
    'timeout':5 //超时时间  
},result => { 
    this.ox_code = result.result.code;
    this.ox_result = JSON.stringify(result);
    let status = '';
    if(this.ox_code =='00000'){
        status = '成功';
    }else{
        status = '失败';
    }
});

返回参数

1. 本机号token校验

根据第二步获取的access_token，与服务端进行token校验；详细参见Demo

三、其他

1. 获取设备网络

获取设备当前的网络类型等信息

使用示例

/**
 *网络类型及运营商（双卡下，获取上网卡的运营商）
 *"carrier"     运营商：0.未知 / 1.中国移动 / 2.中国联通 / 3.中国电信
 *"networkType" 网络类型：0.无网络/ 1.数据流量 / 2.wifi / 3.数据+wifi
 */
OXSDKModule.networkInfo((networkInfo) => {  
    this.ox_result = JSON.stringify(networkInfo);
});