AppCan插件API功能扩展之uexGestureUnlock.docx

uexGestureUnlock 1、简介 1.1、说明 1.2、开源源码 1.3、插件截图 2、 API 2.1、 方法 isGestureCodeSet 检测是否已设置手势密码 resetGestureCode 重置手势密码 config 配置插件 verify 验证手势密码 create 设置手势密码 cancel 终止手势密码验证/设置过程 2.2、 回调方法 cbIsGestureCodeSet 检测是否已设置手势密码的回调方法 cbVerify 验证手势密码的回调方法 cbCreate 设置手势密码的回调方法 2.3、 监听方法 onEventOccur 插件事件发生的监听方法 3、附录 uexGestureUnlockError 错误代码列表 uexGestureUnlockEvent 事件代码列表 4、更新历史 iOS Android1、简介手势密码插件1.1、说明封装了设置手势密码,验证手势密码等功能1.2、开源源码点击至插件详情页(插件测试用例与插件包已经提供)1.3、插件截图2、 API2.1、 方法isGestureCodeSet 检测是否已设置手势密码uexGestureUnlock.isGestureCodeSet();说明 检测系统储存中是否存在已设置的手势密码 会触发回调cbIsGestureCodeSet 检测是否已设置手势密码的回调方法参数无平台支持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. 各字段含义如下:keyvalue 类型说明默认值备注minimumCodeLengthNumber设置密码时的最短长度4至少为1maximumAllowTrialTimesNumber验证密码时的最多尝试次数5设置为0时表示没有上限,errorRemainIntervalNumber错误状态的保留时间1.0successRemainIntervalNumber操作成功后的保留时间0.2操作成功后,经过此时间之后才会关闭插件UIbackgroundColorString手势解锁界面的背景色“#F1F1F1”支持 3位6位8位的HEXcolor/ RBG / RBGAnormalThemeColorString普通状态下的主题颜色“#002849”同上selectedThemeColorString选中状态下的主题颜色“#22B2F6”同上errorThemeColorString错误状态下的主题颜色“#FE525C”同上creationBeginPromptString设置手势密码前的提示文字“请设置手势密码”codeLengthErrorPromptString密码长度低于最短长度的错误提示文字“请至少连续绘制%d个点”%d会被替换成当前的最短密码长度codeCheckPromptString确认手势手势密码,要求再次绘制的提示文字“请再次绘制手势密码”checkErrorPromptString再次绘制的图案不一致的提示文字“与首次绘制不一致,请再次绘制”creationSucceedPromptString设置手势密码成功的提示文字“手势密码设置成功”verificationBeginPromptString验证手势前的提示文字“请验证手势密码”verificationErrorPromptString验证手势密码失败的提示文字“验证错误!您还可以尝试%d次”%d会被替换成当前剩余次数verificationSucceedPromptString验证手势密码成功的提示文字“验证通过”cancelVerificationButtonTitleString取消验证的按钮文字“忘记密码?”cancelCreationButtonTitleString取消设置手势密码的按钮文字“取消设置手势密码”restartCreationButtonTitleString重新设置手势密码的按钮文字“重新设置手势密码”backgroundImageString背景图的文件路径无图片不存在时不会显示,只支持file:/ wgt:/ res:/iconImageString头像的文件路径无同上平台支持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:59. 10. uexGestureUnlock.config(JSON.stringify(data);verify 验证手势密码uexGestureUnlock.verify();说明 打开插件页面进行验证手势密码操作 验证过程中会会有监听onEventOccur 插件事件发生的监听方法 验证过程结束会有回调cbVerify 验证手势密码的回调方法参数无平台支持Android 2.2+iOS 7.0+版本支持Android 3.0.0+iOS 3.0.0+示例1. uexGestureUnlock.verify();create 设置手势密码uexGestureUnlock.create(params);说明 打开插件页面,先验证手势密码,再进行设置手势密码的操作 如果当前未设置手势密码,则会跳过验证手势密码的步骤 验证过程中会会有监听onEventOccur 插件事件发生的监听方法 验证过程结束会有回调cbCreate 设置手势密码的回调方法参数1. var params = 2. isNeedVerifyBeforeCreate:3. 各字段含义如下:参数名称参数类型是否必选说明isNeedVerifyBeforeCreateBoolean否创建密码之前是否需要验证已经设置的手势密码,默认为true。当为false时,会强制跳过验证手势密码的步骤直接设置新密码平台支持Android 2.2+iOS 7.0+版本支持Android 3.0.0+iOS 3.0.0+示例1. var data=2. isNeedVerifyBeforeCreate:false3. 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/false3. 平台支持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. errorCode详见附录-uexGestureUnlockError 错误代码列表平台支持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. errorCode详见附录-uexGestureUnlockError 错误代码列表 当且仅当isFinished回调为true时,会将用户设置的密码存入本地储存 应用重启/覆盖升级不影响密码储存,但应用删除会清除掉密码记录平台支持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. eventCode详见附录-uexGestureUnlockEvent 事件代码列表示例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手