matrixLock

来自于：开发者立即使用

openSetView checkGesture clearGesture showSetView hideSetView closeSetView openEnterView showEnterView hideEnterView closeEnterView

概述

matrixLock 模块是一个矩阵锁，可加锁屏幕，让用户通过输入特定的矩阵路线来解锁屏幕。手势密码会被加密存储到本地。本模块允许开发者自定义矩阵锁屏大小，矩阵的行列数，每个矩阵的元素亦可自定义其样式。模块内接口列表可分为两部分：设置手势密码界面、验证手势密码界面，通过设置手势密码界面可让用户设置自己的手势密码，然后通过验证界面验证设置的密码。

openSetView

打开设置密码页面

openSetView({params}, callback(ret, err))

params

bg：

  • 类型：字符串
  • 默认值：rgba(0,0,0,0)
  • 描述：背景设置，支持img，#，rgb，rgba，可为空

x:

  • 类型：数字
  • 默认值：0
  • 描述：地图视图左上角点的x坐标，可为空

y:

  • 类型：数字
  • 默认值：100
  • 描述：地图视图左上角点的y坐标，可为空

w:

  • 类型：数字
  • 默认值：当前设备屏幕的宽
  • 描述：设置手势密码视图的宽，可为空

h:

  • 类型：数字
  • 默认值：w+w/3.0
  • 描述：设置手势密码视图的高，可为空

tips：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：提示文字配置，可为空

内部字段：

  1. {
  2.     size：            //提示文字大小，数字类型，默认12，可为空
  3.     color:           //提示文字颜色，字符串,默认#696969,支持#,rgb,rgba，可为空
  4.     sizeError：        //错误提示文字大小，数字类型，默认12，可为空
  5.     colorError:      //错误提示文字颜色，字符串,默认#FF3030,支持#,rgb,rgba，可为空
  6. }

matrix：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：矩阵配置，可为空

内部字段:

  1. { 
  2.     row:                //矩阵行数，数字类型，默认3，可为空
  3.     column:             //矩阵列数，数字类型，默认3，可为空
  4.     radius：            //矩阵元素的半径，数字类型，默认80，可为空
  5.     activeBg:           //滑动经过元素的背景，字符串，默认#8deeee圆环加圆点,支持#,rgb,rgba,img,可空
  6.     inactiveBg：        //元素常态时的背景，字符串，默认#e8e8e8圆环,支持#,rgb,rgba,img,可空
  7.     errorBg:            //报错时滑动经过元素的背景，字符串，默认#FF3030圆环加圆点,支持#,rgb,rgba,img,可空
  8.     normalLine:         //常态时元素间连接线颜色,字符串,默认#9ac0cd,支持#,rgb,rgba,可空
  9.     errorLine:             //错误时元素间连接线颜色,字符串,默认#a0522d,支持#,rgb,rgba,可空
  10.     lineWidth：            //连接线线条的粗细，数字类型，默认5，可为空
  11.     arrow：                //手势走向指示箭头色值，支持 rgb，rgba，#，默认#8deee，可为空
  12.     arrowError:            //报错时手势走向指示箭头色值，支持 rgb，rgba，#，默认#8deee，可为空
  13. }

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：打开时是否添加从下往上弹出的动画，可为空

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：模块依附于当前 window

fixed：

  • 类型：布尔
  • 默认值：true
  • 描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //设置手势密码成功
  3. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  3.     code:       //错误描述，取值范围及其错误信息如下：
  4.     -1：//未知错误
  5.     0：//至少连接四个点,请重新输入
  6.     1：//与上一次绘制不一致,请重新绘制
  7.     2:你已经设置过密码了
  8. }

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.openSetView(function(ret, err) {
  3.     if (ret.status) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

checkGesture

检查是否已设置手势密码

checkGesture(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     code:       //手势密码设置状态码，取值范围及其信息如下：
  3.     -1：        //未知错误
  4.     0：            //用户已设计手势密码
  5.     1：            //用户未设置手势密码
  6. }

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.checkGesture(function(ret, err) {
  3.     if (ret) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

clearGesture

清空设置的手势密码

clearGesture(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //布尔类型，操作是否成功
  3. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //字符串类型，操作失败信息
  3. }

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.clearGesture();

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showSetView

显示矩阵锁视图

showSetView({params})

params

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：显示时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.showSetView();

补充说明

显示已经隐藏的矩阵锁视图

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hideSetView

隐藏矩阵锁视图

hideSetView({params})

params

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：隐藏时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.hideSetView();

补充说明

隐藏矩阵锁视图，并没有从内存中清除

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

closeSetView

关闭设置密码页面

closeSetView({params})

params

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：打开时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.closeSetView();

补充说明

关闭视图

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openEnterView

打开验证手势密码视图

openEnterView({params}, callback(ret, err))

params

bg：

  • 类型：字符串
  • 默认值：rgba(0,0,0,0)
  • 描述：背景设置，支持img，#，rgb，rgba，可为空

x:

  • 类型：数字
  • 默认值：0
  • 描述：地图视图左上角点的x坐标，可为空

y:

  • 类型：数字
  • 默认值：207
  • 描述：地图视图左上角点的y坐标，可为空

w:

  • 类型：数字
  • 默认值：当前设备屏幕的宽
  • 描述：设置手势密码视图的宽，可为空

h:

  • 类型：数字
  • 默认值：w
  • 描述：设置手势密码视图的高，可为空

matrix：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：矩阵配置，可为空

内部字段:

  1. { 
  2.     row:                //矩阵行数，数字类型，默认3，可为空
  3.     column:             //矩阵列数，数字类型，默认3，可为空
  4.     radius：            //矩阵元素的半径，数字类型，默认80，可为空
  5.     activeBg:           //滑动经过元素的背景，字符串，默认#8deeee圆环加圆点,支持#,rgb,rgba,img,可空
  6.     inactiveBg：        //元素常态时的背景，字符串，默认#e8e8e8圆环,支持#,rgb,rgba,img,可空
  7.     errorBg:            //报错时滑动经过元素的背景，字符串，默认#FF3030圆环加圆点,支持#,rgb,rgba,img,可空
  8.     normalLine:         //常态时元素间连接线颜色,字符串,默认#9ac0cd,支持#,rgb,rgba,可空
  9.     errorLine:             //错误时元素间连接线颜色,字符串,默认#a0522d,支持#,rgb,rgba,可空
  10.     lineWidth：            //连接线线条的粗细，数字类型，默认5，可为空
  11.     arrow：                //手势走向指示箭头色值，支持 rgb，rgba，#，默认#8deee，可为空
  12.     arrowError:            //报错时手势走向指示箭头色值，支持 rgb，rgba，#，默认#8deee，可为空
  13. }

anim：

  • 类型：布尔值
  • 默认值：true
  • 描述：打开时是否添加从下往上弹出的动画，可为空

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：模块依附于当前 window

fixed：

  • 类型：布尔
  • 默认值：true
  • 描述：是否将模块视图固定到窗口上，不跟随窗口上下滚动，可为空

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //密码正确
  3. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     code:       //验证手势密码错误码，取值范围及其错误信息如下：
  3.     -1：        //未知错误
  4.     0：            //尚未设置手势密码
  5.     1：            //用户输入手势密码错误
  6. }

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.openEnterView(function(ret, err) {
  3.     if (ret.status) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

showEnterView

显示手势密码验证视图

showEnterView({params})

params

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：显示时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.showEnterView();

补充说明

显示已经隐藏的矩阵锁视图

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hideEnterView

隐藏手势密码验证矩阵锁视图

hideEnterView({params})

params

anim：

  • 类型：布尔值
  • 默认值：false
  • 描述：隐藏时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.hideEnterView();

补充说明

隐藏矩阵锁视图，并没有从内存中清除

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

closeEnterView

关闭手势验证视图

closeEnterView({params})

params

anim：

  • 类型：布尔值
  • 默认值：true
  • 描述：打开时是否添加从下往上弹出的动画，可为空

示例代码

  1. var matrixLock = api.require('matrixLock');
  2. matrixLock.closeEnterView();

补充说明

关闭视图

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本