# Pwdkey

• 方法
  • show 显示安全键盘
  • hide 隐藏密码键盘
  • showKeyBoard 显示cfca安全键盘
  • hideKeyBoard 隐藏cfca密码键盘
  • comparePwdForCFCA cfca密码键盘内容比较
  • destroyPwdForCFCA cfca密码键盘销毁
  • isShowPwdForCFCA 指定cfca密码键盘是否打开
  • clearPwdForCFCA 清空指定cfca密码键盘的内容

# show

显示安全键盘，使用“md5”，“aes”，“rsa”，“sm2”，“sm4”，"cfca"加密的密码键盘

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	调用安全键盘参数设置，详见下表
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  type	String	是	加密方式值：“md5”，“aes”，“rsa”，“sm2”，“sm4” rsa:返回用app内置的公钥加密，然后base64之后的密文字符串
  number	Boolean	可选	是否开启数字键盘,false不开启/true开启
  confusion	Number	可选	是否混乱排序,0：正序，1：乱序,默认:1
  max	Number	可选	输入最大长度,默认100
  presses	Boolean	可选	是否显示按压，true：显示，false：不显示，默认：true
  input	String	可选	输入正则表达式,默认不开启，有值则只能在安全键盘输入符合该正则表达式的字符
  encrypt	String	是	加密因子/对称密钥, aes，sm4加密必传，
  sm2Px	String	是	sm2专用,P点的x坐标值,sm2必传
  sm2Py	String	是	sm2专用,P点的x坐标值,sm2必传

• completedCB返回参数说明

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

• 返回payload参数说明

  参数名	类型	说明
  data	String	输入的数据，比如"****"，cfca方式不返回
  cipherText	String	加密后的数据
  keyboardHeight	String	cfca专用，其它方式不返回，键盘弹起的高度
  textLength	String	cfca专用，其它方式不返回，键盘字符长度
  type	String	cfca专用，”键盘输入发生改变“
  pwdType	String	cfca专用，cfca键盘码组
  randomEncode	String	cfca专用，cfca密码键盘返回状态码
  text	String	cfca专用，cfca键盘输入框明文

• 示例代码

var options = {type:'md5'}
foxsdk.pwdkey.show(options, ret => {
    console.log('keybord/show===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# hide

隐藏密码键盘

• 参数说明

  参数名	类型	必填	说明
  options	Object	可选	如果隐藏cfca键盘时，此参数是必须的，传入键盘id ，其他方式不传

• options

  参数名	类型	必填	说明
  id	String	可选	如果隐藏cfca键盘时，此参数是必须的 ，其他方式不传

• completedCB返回参数说明

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

• 示例代码

foxsdk.pwdkey.hide(options,ret => {
    console.log('keybord/hide===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# showkeyboard

显示cfca安全键盘

• 参数说明

  参数名	类型	必填	说明
  data	Object	是	调用安全键盘参数设置，详见下表
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• data参数说明

  参数名	类型	必填	说明
  id	String	可选	cfca专用，cfca键盘id
  random	String	必填	16位随机字符串，aes和sm4必填
  order	String	可选	cfca专用，设置键盘乱序类型，0不乱序，1仅数字乱序，2全乱序
  keyType	Number	可选	cfca专用，安全输入控件对应的键盘类型,0全键盘,1数字键盘,2密码键盘,3id键盘
  encryptFlag	BOOL	可选	cfca专用，输入数据是否需要加密,YES是加密，NO是不加密
  encryptType	String	可选	cfca专用，可选'rsa','sm2'

• completedCB返回参数说明

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

• 返回payload参数说明

  参数名	类型	说明
  data	String	输入的数据，比如"****"，cfca方式不返回
  cipherText	String	加密后得数据
  keyboardHeight	String	cfca专用，其它方式不返回，键盘弹起的高度
  textLength	String	cfca专用，其它方式不返回，键盘字符长度
  type	String	cfca专用，”键盘输入发生改变“
  pwdType	String	cfca专用，cfca键盘码组
  randomEncode	String	cfca专用，cfca密码键盘返回状态码
  text	String	cfca专用，cfca键盘输入框明文

• 示例代码

foxsdk.pwdkey.show({type:'aes',random:'jikodlskemdjskqm'}, ret => {
    console.log('keybord/showkeyboard===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# hidekeyboard

隐藏cfca密码键盘

• 参数说明

  参数名	类型	必填	说明
  options	Object	可选	如果隐藏cfca键盘时，此参数是必须的，传入键盘id

• options

  参数名	类型	必填	说明
  id	String	可选	如果隐藏cfca键盘时，此参数是必须的

• completedCB返回参数说明

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

• 示例代码

foxsdk.pwdkey.hide(ret => {
    console.log('keybord/hidekeyboard===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# comparepwdforcfca

cfca专用，密码键盘对象对比

• 参数说明

  参数名	类型	必填	说明
  options	Object	可选	如果隐藏cfca键盘时，此参数是必须的，传入键盘id ，其他方式不传

• options

  参数名	类型	必填	说明
  id	String	可选	如果隐藏cfca键盘时，此参数是必须的 ，其他方式不传
  confirmId	String	可选	如果隐藏cfca键盘时，此参数是必须的 ，其他方式不传

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	cfca 返回对象，其他方式返回空

• payload

  参数名	类型	必填	说明
  result	Number	可选	cfca键盘内容相同 ，其他方式不传

• 示例代码

foxsdk.pwdkey.comparePwdForCFCA(options, ret => {
    console.log('keybord/hide===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# destroypwdforcfca

cfca专用，销毁屏幕上的cfca密码键盘

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	‘键盘销毁成功’

• 示例代码

foxsdk.pwdkey.destroyPwdForCFCA(ret => {
    console.log('keybord/hide===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# isshowpwdforcfca

• 参数说明

  参数名	类型	必填	说明
  options	Object	可选	如果使用cfca键盘时，此参数是必须的，传入键盘id ，其他方式不传

• options

  参数名	类型	必填	说明
  id	String	可选	如果隐藏cfca键盘时，此参数是必须的 ，其他方式不传

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	cfca 返回‘指定键盘是否打开’

• 示例代码

foxsdk.pwdkey.isShowPwdForCFCA(options, ret => {
    console.log('keybord/hide===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# clearpwdforcfca

• 参数说明

  参数名	类型	必填	说明
  options	Object	可选	如果使用cfca键盘时，此参数是必须的，传入键盘id ，其他方式不传

• options

  参数名	类型	必填	说明
  id	String	可选	如果使用cfca键盘时，此参数是必须的 ，其他方式不传

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	cfca 返回‘清除指定安全控件内容’

• 示例代码

foxsdk.pwdkey.clearPwdForCFCA(options, ret => {
    console.log('keybord/hide===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});