upyunQuickLogin

config

customUIWithConfig

isSetupClient

getToken

preLogin

getAuthorizationWithController

dismissLoginController

checkVerifyEnable

clearPreLoginCache

概述

封装了又拍云一键登录SDK

config

配置

config({params},callback(ret))

params

appKey（仅ios支持）：

channel（仅ios支持）：

  • 类型：字符串类型
  • 描述：（可选项）发布渠道.，默认为空

isProduction：

  • 类型：布尔类型
  • 描述：（可选项）是否生产环境. 如果为开发状态,设置为false;如果为生产状态,应改为true
  • 默认：true

timeout：

  • 类型：数字类型
  • 描述：（可选项）设置初始化超时时间，单位毫秒，合法范围是(0,30000]，推荐设置为5000-10000
  • 默认：10000

android使用此原生插件之前必须先配置 config 文件，配置方法如下：

    <meta-data name="JPUSH_APPKEY" value="aacc4ba2df5c500b0274b3e1"/>
    <meta-data name="JPUSH_CHANNEL" value="default_developer"/>

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   result:'',  //json对象；返回结果, 8000为初始化成功，其他结果请查看https://github.com/upyun/iOS-QuickLogin
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.config({
  appKey:''
},function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

customUIWithConfig

自定义登录页UI样式参数

customUIWithConfig({params})

params

styles：

  • 类型：JSON 对象
  • 描述：（可选项）原生插件各部分的样式
  • 内部字段：
{
    navDic:{  //（可选项）JSON对象类型；导航栏设置
        navText:'', //（可选项）字符串类型；导航栏标题；默认：'登陆'
        navTextColor:'',   //（可选项）字符串类型；导航栏标题颜色；默认：'#FFFFFF'
        navColor:'', //（可选项）字符串类型；导航栏颜色；默认：'#1E90FF'
    },
    logDic:{  //（可选项）JSON对象类型；登陆按钮设置
        logBtnText:'', //（可选项）字符串类型；登录按钮文本；默认：'登陆'
        logBtnTextColor:'',   //（可选项）字符串类型；登录按钮文本颜色；默认：'#FFFFFF'
        logBtnFont:13,         //（可选项）数字类型；登录按钮文字大小；默认：13
    },
    numberDic:{  //（可选项）JSON对象类型；手机号码设置
        numberColor:'',   //（可选项）字符串类型；手机号码文本颜色；默认：'#FFFFFF'
        numberFont:11,         //（可选项）数字类型；手机号码文字大小；默认：11
    },
    appPrivacyOne:[],      //数组类型；隐私条款一:数组（务必按顺序），[条款名称,条款链接]
    appPrivacyTwo:[],      //数组类型；隐私条款二:数组（务必按顺序），[条款名称,条款链接]
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.customUIWithConfig({
  styles:{
    appPrivacyOne:[],
    appPrivacyTwo:[]
  }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isSetupClient

初始化过程是否完成

isSetupClient(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   ststus:true,//布尔类型；初始化过程是否完成
}

示例代码

var upyunQuickLogin = api.require('upyunQuickLogin');
upyunQuickLogin.isSetupClient(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getToken(仅ios支持)

配置

getToken({params},callback(ret))

params

timeout：

  • 类型：数字类型
  • 描述：（可选项）超时。单位ms,默认为5000ms。合法范围(0,10000]
  • 默认：5000

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   result:{},  //json对象；token相关信息
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.getToken({
  timeout:5000
},function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统

可提供的1.0.0及更高版本

preLogin

获取手机号校验token

preLogin({params},callback(ret))

params

timeout：

  • 类型：数字类型
  • 描述：（可选项）超时。单位ms,默认为5000ms。合法范围(0,10000]
  • 默认：5000

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   result:{},  //json对象；预取号结果
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.preLogin({
  timeout:5000
},function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getAuthorizationWithController

授权登录

getAuthorizationWithController({params},callback(ret))

params

hide：

  • 类型：布尔类型
  • 描述：（可选项）完成后是否自动隐藏授权页
  • 默认：true

animated：

  • 类型：布尔类型
  • 描述：（可选项）拉起授权页时是否需要动画效果
  • 默认：true

timeout：

  • 类型：数字类型
  • 描述：（可选项） 超时。单位毫秒，合法范围是(0,30000]，默认值为10000。此参数同时作用于拉起授权页超时 ，以及点击授权页登录按钮获取LoginToken超时
  • 默认：10000

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   eventType:'',      //字符串类型；事件回调，取值范围如下：
                        //completion:登录结果
                        //action:授权页事件触发回调
   result:{},  //json对象；登录结果；completion返回
   type:0,    //数字类型；事件类型；action返回
   content:'' //字符串类型；事件描述；action返回
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.getAuthorizationWithController({
  timeout:10000
},function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

dismissLoginController

隐藏登录页.当授权页被拉起以后，可调用此接口隐藏授权页。当一键登录自动隐藏授权页时，不建议调用此接口

dismissLoginController({params},callback(ret))

params

animated：

  • 类型：布尔类型
  • 描述：（可选项）隐藏时是否需要动画
  • 默认：true

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   eventType:'finish',      //字符串类型；完成回调
}

示例代码

var upyunQuickLogin= api.require('upyunQuickLogin');
upyunQuickLogin.dismissLoginController({
  animated:true
},function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

checkVerifyEnable

判断当前手机网络环境是否支持认证

checkVerifyEnable(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   ststus:true,//布尔类型；当前手机网络环境是否支持认证，true 支持, false 不支持
}

示例代码

var upyunQuickLogin = api.require('upyunQuickLogin');
upyunQuickLogin.checkVerifyEnable(function(ret){
  console.log(JSON.stringify(ret))
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

clearPreLoginCache

清除预取号缓存

clearPreLoginCache()

示例代码

var upyunQuickLogin = api.require('upyunQuickLogin');
upyunQuickLogin.clearPreLoginCache();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24