sguap mobile7 uap mobile api referenceuap_plug_api-1

1、uexGestureUnlock1、简介 2、API概览 3、更新历史 1、简介手势插件 1.1 、说明封装了设置手势,验证手势等功能 1.2 、开源源码点击至插件详情页(插件测试用例与插件包已经提供)1.3 、插件截图1.4 、平台版本支持本插件的所有API默认支持Android4.0+和iOS7.0+操作系统. 有特殊版本要求的API会在文档中额外说明.1.5 、接口有效性本插件所有API默认在插件版本4.0.0+可用.在后续版本中新添加的接口会在文档中额外说明.2、 API2.1、 方法isGestureCodeSet /检测是否已设置手势uexGestureUnlock.isGestu

2、reCodeSet();说明检测系统储存中是否存在已设置的手势参数无 返回值:Boolean类型,已设置手势时返回true,否则返回false示例var ret = uexGestureUnlock.isGestureCodeSet(); alert(ret);isGestureCodeSetresetGestureCodeconfigverify createcancelonEventOccurresetGestureCode /重置手势uexGestureUnlock.resetGestureCode();说明移除系统储存中的手势(如果存在)参数无示例uexGestureUnlock.re

3、setGestureCode();config /配置插件uexGestureUnlock.config(param);说明配置插件的相关属性 每次调用此接口,均会覆盖之前的配置 所有的key均是可选参数,不传时会设置为默认值参数var params = minimumCodeLength:, maximumAllowTrialTimes:, errorRemainInterval:, successRemainInterval:, backgroundColor:, normalThemeColor:, selectedThemeColor:, errorThemeColor:, creat

4、ionBeginPrompt:, codeLengthErrorPrompt:, codeCheckPrompt:, checkErrorPrompt:, creationSucceedPrompt:, verificationBeginPrompt:, verificationErrorPrompt:, verificationSucceedPrompt:, cancelVerificationButtonTitle:, cancelCreationButtonTitle:, restartCreationButtonTitle:, backgroundImage:, iconImage:各

5、字段含义如下:value类型key说明默认值备注minimumCodeLengt hNumber4至少为1设置时的最短长度 maximumAllowTrialTi mesNumber5设置为0时表示没有上限,验证时的最多尝试次数 errorRemainIntervalNumber1.0错误状态的保留时间 0.2默认值操作成功后,经过此时间之后才会 备关备闭注插件UIsuccessRemainInter vkaelyNvuamlubeer类型操作成功后的保留时间 说明backgroundColorString#F1F1F1支持 3位6位8位的HEXcolor/ RBG/ RBGA手势解锁界面的背

6、景色 normalThemeColorString#002849普通状态下的主题颜色 同上selectedThemeColo rString#22B2F6选中状态下的主题颜色 同上errorThemeColorString#FE525C错误状态下的主题颜色 同上StringcreationBeginPromp t请设置手势设置手势前的提示文字 StringcodeLengthErrorPro mpt请至少连续绘制%d个点%d会被替换成当前的最短度 长度低于最短长度的错误提示文字 长codeCheckPromptString确认手势手势,要求再次绘制的提示文字 请再次绘制手势checkError

7、PromptString与首次绘制不一致,请再次绘制再次绘制的图案不一致的提示文字 String手势设置成功creationSucceedPro mpt设置手势成功的提示文字 StringverificationBeginPro mpt请验证手势验证手势前的提示文字 StringverificationErrorPro mpt验证错误!您还可以尝试%d次%d会被替换成当前剩余次数验证手势失败的提示文字 verificationSucceed PromptString验证通过验证手势成功的提示文字 cancelVerificationBu ttonTitleString忘记?取消验证的按钮文字

8、StringcancelCreationButto nTitle取消设置手势取消设置手势的按钮文字 StringrestartCreationButto nTitle重新设置手势重新设置手势的按钮文字 backgroundImageString图片不存在时不会显示,只支持 file:/ wgt:/ res:/背景图的文件路径 无iconImageString头像的文件路径 无同上示例vardata= backgroundImage:res:/bgImage.jpg, iconImage:res:/icon.png, normalThemeColor:#F1F1F1, selectedTheme

9、Color:#00ff00, errorThemeColor:#ff0000, cancelVerificationButtonTitle:切换其他账号, minimumCodeLength:5uexGestureUnlock.config(data);verify /验证手势uexGestureUnlock.verify(cb);说明打开插件页面进行验证手势操作 onEventOccur 插件验证过程中会会有发生的方法 参数参数名称参数类型是否必选说明cbFunction结束时,会调用此回调函数 是验证手势回调参数var cb = function(error, data)参数名称参数类型说

10、明errorNumber验证,0表示验证成功,非0表示验证失败时错误码 是否完成了手势dataString验证失败时的错误描述 示例uexGestureUnlock.verify(function(error, data) if(!error)alert(验证成功);elsealert(验证失败, + data););create /设置手势uexGestureUnlock.create(config,cb);说明打开插件页面,先验证手势,再进行设置手势的操作的步骤 发生的如果当前未设置手势,则会跳过验证手势验证过程中会会有onEventOccur 插件方法 参数参数名称参数类型是否必选说明c

11、onfigStringconfig是JSON字符串,表示设置手势的配置信息,如不需要配置,此参数传null是cbFunction设置手势结束时,会调用此回调函数 是var config = isNeedVerifyBeforeCreat e:各字段含义如下:是否必选字段名称类型说明isNeedVerifyBeforBool之前是否需要验证已经设置的手势,默认为true.当为false时,会强制跳过验证的步骤直接设置新是否否必选创建说手势明eCreateean字段名称类型回调参数var cb = function(error, data)参数名称参数类型说明errorNumber设置,0表示设置

12、成功,非0表示设置失败时错误码 是否完成了手势dataString设置失败时的错误描述 error非0时错误码详见附录-uexGestureUnlockError 错误代码列表当且仅当error为0时,会将用户设置的存入本地储存 应用重启/覆盖升级不影响储存,但应用删除会清除掉记录示例vardata= isNeedVerifyBeforeCreate:fals euexGestureUnlock.create(data,function(error, data) if(!error)alert(设置成功);elsealert(设置失败, + data);cancel /终止手势验证/设置过程u

13、exGestureUnlock.cancel();说明强制关闭由verify或者create调起的插件界面,终止相应的操作步骤 参数无示例uexGestureUnlock.cancel();2.2、方法onEventOccur /插件发生的方法uexGestureUnlock.onEventOccur(param);说明时,会触发此当插件触发相应的 参数参数名称参数类型说明paramStringjson格式,形式见下：javascript var param=eventCode:/Number ,必选,插件代码 eventCode详见附录-uexGestureUnlockEvent代码列表 示

14、例javascript window.uexOnload=function(type)uexGestureUnlock.onEventOccur=function(info) alert(info);3、附录uexGestureUnlockErrorerrorCode描述1在未设置的情况下进行验证操作 2用户取消了创建过程 3用户取消了验证过程 4尝试次数过多 5插件被cancel接口强制关闭 6发生未知错误uexGestureUnlockEventeventCode描述1插件初始化2开始手势验证 3手势验证失败 4验证过程被用户取消 5手势验证成功 6开始手势设置 7用户输入的不符合长度要求 8开始第二次输入手势 9两次输入的不一致 10手势设置被用户取消 11手势设置完成 4、更新历史iOSAPI版本: uexGestureUnlock-4