AppCan文档中心-uexGestureUnlock
 
下载文档

uexGestureUnlock
更新时间:2016-01-06

1、简介

手势密码插件

1.1、说明

封装了设置手势密码,验证手势密码等功能

1.2、开源源码

点击至插件详情页(插件测试用例与插件包已经提供)

1.3、插件截图

screenshot1screenshot2screenshot3


2、 API

2.1、 方法

isGestureCodeSet 检测是否已设置手势密码

uexGestureUnlock.isGestureCodeSet();

说明

参数

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexGestureUnlock.isGestureCodeSet();

resetGestureCode 重置手势密码

uexGestureUnlock.resetGestureCode();

说明

  • 移除系统储存中的手势密码(如果存在)

参数

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexGestureUnlock.resetGestureCode();

config 配置插件

uexGestureUnlock.config(param);

说明

  • 配置插件的相关属性
  • 每次调用此接口,均会覆盖之前的配置
  • 所有的key均是可选参数,不传时会设置为默认值

参数

  1. var params = {
  2. minimumCodeLength:,
  3. maximumAllowTrialTimes:,
  4. errorRemainInterval:,
  5. successRemainInterval:,
  6. backgroundColor:,
  7. normalThemeColor:,
  8. selectedThemeColor:,
  9. errorThemeColor:,
  10. creationBeginPrompt:,
  11. codeLengthErrorPrompt:,
  12. codeCheckPrompt:,
  13. checkErrorPrompt:,
  14. creationSucceedPrompt:,
  15. verificationBeginPrompt:,
  16. verificationErrorPrompt:,
  17. verificationSucceedPrompt:,
  18. cancelVerificationButtonTitle:,
  19. cancelCreationButtonTitle:,
  20. restartCreationButtonTitle:,
  21. backgroundImage:,
  22. iconImage:
  23. }

各字段含义如下:

key value 类型 说明 默认值 备注
minimumCodeLength Number 设置密码时的最短长度 4 至少为1
maximumAllowTrialTimes Number 验证密码时的最多尝试次数 5 设置为0时表示没有上限,
errorRemainInterval Number 错误状态的保留时间 1.0
successRemainInterval Number 操作成功后的保留时间 0.2 操作成功后,经过此时间之后才会关闭插件UI
backgroundColor String 手势解锁界面的背景色 “#F1F1F1” 支持 3位6位8位的HEXcolor/ RBG / RBGA
normalThemeColor String 普通状态下的主题颜色 “#002849” 同上
selectedThemeColor String 选中状态下的主题颜色 “#22B2F6” 同上
errorThemeColor String 错误状态下的主题颜色 “#FE525C” 同上
creationBeginPrompt String 设置手势密码前的提示文字 “请设置手势密码”
codeLengthErrorPrompt String 密码长度低于最短长度的错误提示文字 “请至少连续绘制%d个点” %d会被替换成当前的最短密码长度
codeCheckPrompt String 确认手势手势密码,要求再次绘制的提示文字 “请再次绘制手势密码”
checkErrorPrompt String 再次绘制的图案不一致的提示文字 “与首次绘制不一致,请再次绘制”
creationSucceedPrompt String 设置手势密码成功的提示文字 “手势密码设置成功”
verificationBeginPrompt String 验证手势前的提示文字 “请验证手势密码”
verificationErrorPrompt String 验证手势密码失败的提示文字 “验证错误!您还可以尝试%d次” %d会被替换成当前剩余次数
verificationSucceedPrompt String 验证手势密码成功的提示文字 “验证通过”
cancelVerificationButtonTitle String 取消验证的按钮文字 “忘记密码?”
cancelCreationButtonTitle String 取消设置手势密码的按钮文字 “取消设置手势密码”
restartCreationButtonTitle String 重新设置手势密码的按钮文字 “重新设置手势密码”
backgroundImage String 背景图的文件路径 图片不存在时不会显示,只支持file:// wgt:// res://
iconImage String 头像的文件路径 同上

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. var data={
  2. backgroundImage:"res://bgImage.jpg",
  3. iconImage:"res://icon.png",
  4. normalThemeColor:"#F1F1F1",
  5. selectedThemeColor:"rgb(33,233,164)",
  6. errorThemeColor:"rgba(250,45,116,0.4)",
  7. cancelVerificationButtonTitle:"切换其他账号",
  8. minimumCodeLength:5
  9. }
  10. uexGestureUnlock.config(JSON.stringify(data));

verify 验证手势密码

uexGestureUnlock.verify();

说明

参数

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexGestureUnlock.verify();

create 设置手势密码

uexGestureUnlock.create(params);

说明

参数

  1. var params = {
  2. isNeedVerifyBeforeCreate:
  3. }

各字段含义如下:

参数名称 参数类型 是否必选 说明
isNeedVerifyBeforeCreate Boolean 创建密码之前是否需要验证已经设置的手势密码,默认为true。当为false时,会强制跳过验证手势密码的步骤直接设置新密码

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. var data={
  2. isNeedVerifyBeforeCreate:false
  3. }
  4. uexGestureUnlock.create(JSON.stringify(data));

cancel 终止手势密码验证/设置过程

uexGestureUnlock.cancel();

说明

  • 强制关闭由verify或者create调起的插件界面,终止相应的操作步骤

参数

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexGestureUnlock.cancel();

2.2、 回调方法

cbIsGestureCodeSet 检测是否已设置手势密码的回调方法

uexGestureUnlock.cbIsGestureCodeSet(param);

说明

检测是否已设置手势密码的回调方法

参数

param为json字符串

  1. var param = {
  2. result://Boolean,必选,是否已设置手势密码 true/false
  3. }

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. window.uexOnload=function(type){
  2. uexGestureUnlock.cbIsGestureCodeSet=function(info){
  3. alert(info);
  4. }
  5. }

cbVerify 验证手势密码的回调方法

uexGestureUnlock.cbVerify(param);

说明

验证手势密码的回调方法

参数

param为json字符串

  1. var param = {
  2. isFinished:,//Boolean,必选,是否完成了手势密码验证
  3. errorCode:,//Number,可选,仅isFinished为false时有此参数,验证未完成的错误代码
  4. errorString:,//String,可选,仅isFinished为false时有此参数,验证未完成的错误描述
  5. }

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. window.uexOnload=function(type){
  2. uexGestureUnlock.cbVerify=function(info){
  3. alert(info);
  4. }
  5. }

cbCreate 设置手势密码的回调方法

uexGestureUnlock.cbCreate(param);

说明

  • 设置手势密码的回调方法

参数

param为json字符串

  1. var param = {
  2. isFinished:,//Boolean,必选,是否完成了手势密码设置
  3. errorCode:,//Number,可选,仅isFinished为false时有此参数,设置手势密码未完成的错误代码
  4. errorString:,//String,可选,仅isFinished为false时有此参数,设置手势密码未完成的错误描述
  5. }

平台支持

Android 2.2+
iOS 7.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. window.uexOnload=function(type){
  2. uexGestureUnlock.cbCreate=function(info){
  3. alert(info);
  4. }
  5. }

2.3、 监听方法

onEventOccur 插件事件发生的监听方法

uexGestureUnlock.onEventOccur(param);

说明

  • 当插件触发相应的事件时,会触发此监听

参数

param为json字符串

  1. var param={
  2. eventCode:,//Number ,必选,插件事件代码
  3. }

示例

  1. window.uexOnload=function(type){
  2. uexGestureUnlock.onEventOccur=function(info){
  3. alert(info);
  4. }
  5. }

3、附录

uexGestureUnlockError 错误代码列表

errorCode 描述
1 在未设置密码的情况下进行验证密码操作
2 用户取消了创建密码过程
3 用户取消了验证密码过程
4 尝试密码次数过多
5 插件被cancel接口强制关闭
6 发生未知错误

uexGestureUnlockEvent 事件代码列表

eventCode 描述
1 插件初始化
2 开始手势密码验证
3 手势密码验证失败
4 验证过程被用户取消
5 手势密码验证成功
6 开始手势密码设置
7 用户输入的密码不符合长度要求
8 开始第二次输入手势密码
9 两次输入的密码不一致
10 手势密码设置被用户取消
11 手势密码设置完成

4、更新历史

iOS

API版本:uexGestureUnlock-3.0.2

最近更新时间:2015-12-26

历史发布版本 更新内容
3.0.2 添加IDE支持
3.0.1 修复maximumAllowTrialTimes拼写错误
3.0.0 uexGestureUnlock 发布

Android

API版本:uexGestureUnlock-3.0.0

最近更新时间:2015-12-04

历史发布版本 更新内容
3.0.0 uexGestureUnlock 发布