# gesture

方法
- clearGestureInfo 删除当前用户的手势信息
- openUnlock 打开手势页面
- currentGesture 获取当前用户手势信息
- clearGestureErrorTimes 重置当前用户手势输入错误次数
- closeUnlock 关闭手势页面
- guide 使用说明

# 删除当前用户的手势信息

api名:clearGestureInfo 删除当前用户的手势信息

支持平台

Android	IOS	HarmonyOS
√	√	√

参数说明

参数名	类型	必填	说明
data	Object	是	删除手势信息参数，详见下表
completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

data参数说明

参数名	类型	必填	说明
userIdentify	String	是	用户唯一标识

completedCB返回参数说明

参数名	类型	说明
status	Number	调用状态码 0成功, 失败请查看全局状态码
message	String	调用结果信息
payload	String	回调结果（空）

示例代码


var data = {"userIdentify":"1234"}
  foxsdk.gesture.clearGestureInfo(data, ret => {
      foxsdk.logger.info('voice/speechText===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
  });

# 打开手势页面

api名:openUnlock,打开手势页面

支持平台

Android	IOS	HarmonyOS
√	√	√

参数说明

参数名	类型	必填	说明
data	Object	是	打开手势页面参数，详见下表
completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

data参数说明

参数名	类型	必填	说明
unlockType	String	是	手势页面类型 1:密码校验。2密码设置 3密码修改 4获取手势(无需参数)
userIdentify	String	是	用户唯一标识
maxErrorTimes	String	否	最大容错次数。默认5
isHidePath	String	否	是否隐藏手势轨迹 1:是其他值:否
name	String	否	昵称
image	String	否	头像

completedCB返回参数说明

参数名	类型	说明
status	Number	调用状态码 0成功, 失败请查看全局状态码
message	String	调用结果信息
payload	String	回调结果（空）

payload参数说明

参数名	类型	说明
gesturePswd	string	用户修改或设置后返回前端的密码密文

示例代码


var data = {"unlockType":"1","userIdentify":"1234","maxErrorTimes":"5"}
  foxsdk.gesture.openUnlock(data, ret => {
      foxsdk.logger.info('voice/speechText===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
  });

# 获取当前用户手势信息

api名:currentGesture,获取当前用户手势信息

支持平台

Android	IOS	HarmonyOS
√	√	√

参数说明

参数名	类型	必填	说明
data	Object	是	获取当前用户手势信息参数，详见下表
completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

data参数说明

参数名	类型	必填	说明
userIdentify	String	是	用户唯一标识

completedCB返回参数说明

参数名	类型	说明
status	Number	调用状态码 0成功, 失败请查看全局状态码
message	String	调用结果信息
payload	String	回调结果（空）

payload参数说明

参数名	类型	说明
gesturePswd	string	用户密码

示例代码


var data = {"userIdentify":"1234"}
  foxsdk.gesture.currentGesture(data, ret => {
      foxsdk.logger.info('voice/speechText===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
  });

# 重置当前用户手势输入错误次数

api名:clearGestureErrorTimes,重置当前用户手势输入错误次数

支持平台

Android	IOS	HarmonyOS
√	√	√

参数说明

参数名	类型	必填	说明
data	Object	是	重置当前用户手势输入错误次数参数，详见下表
completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

data参数说明

参数名	类型	必填	说明
userIdentify	String	是	用户唯一标识

completedCB返回参数说明

参数名	类型	说明
status	Number	调用状态码 0成功, 失败请查看全局状态码
message	String	调用结果信息
payload	String	回调结果（空）

示例代码


var data = {"userIdentify":"1234"}
  foxsdk.gesture.clearGestureErrorTimes(data, ret => {
      foxsdk.logger.info('gesture/clearGestureErrorTimes===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
  });

# 关闭手势页面

api名:closeUnlock 关闭当前手势页面

支持平台

Android	IOS	HarmonyOS
√	√	√

参数说明

参数名	类型	必填	说明
data	Object	必填	api参数对象传{}
completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

completedCB返回参数说明

参数名	类型	说明
status	Number	调用状态码 0成功, 失败请查看全局状态码
message	String	调用结果信息
payload	String	回调结果（空）

示例代码


var data = {"userIdentify":"1234"}
  foxsdk.gesture.closeUnlock(data, ret => {
      foxsdk.logger.info('gesture/closeUnlock===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
  });

# 使用说明

设置手势
1. 设置手势提供给前端调用起手势页面为指定账号设置手势密码的功能,调起方法openUnlock ,需要根据type参数来确定是否是设置类型
2. 设置手势有固定复杂度的检测,至少三个以上的拐点,至少6位,允许不连续的重复点
3. 设置的密码原生会以密文的形式存在本地,也会返回给前端密文
手势验证
1. 手势验证提供验证匹配手势的功能,原生判断验证结果,验证匹配的依据是openUnlock 传递下来的gesturePswd字段,当没有这个参数时会采用原生存储的验证依据来匹配结果
2. 原生存储的匹配依据是经过openUnlock 为设置和重置模式的时候确定下的手势密文
手势重置

1.重置分为两步,先[手势验证] 再 [设置手势],也是通过openUnlock 传入相应的type参数调用起页面
删除当前用户的手势信息
1. 前端可以通过clearGestureInfo 来清理掉用户的手势信息,这样原生不会再本地再保存有用户的手势信息,当前端在调用openUnlock 使用 [手势验证]功能的时候需要带入gesturePswd信息注意此处必须传入密文
获取当前用户手势信息
1. 当前端需要单独使用到用户的手势信息时,原生提供currentGesture 来获取当前用户的手势信息,以密文返回
重置当前用户手势输入错误次数
1. 当用户输入次数超限后,前端如果设计有重新激活验证的需求,可以调用clearGestureErrorTimes 来重置错误试错信息,这样又可以激活验证功能.

← 事件监听多语言 →