跳到主要内容

响应 UI 事件

uiResponse 用于把应用侧收集到的用户输入或选择返回给 SDK。它通常配合 UI_EVENT 使用,例如设备要求填写 PIN、输入 Passphrase 或进行确认时,应用展示 UI,再用 uiResponse 把结果传回。

目前常见的响应类型包括 PIN 和 Passphrase。响应越及时,硬件请求流程越不容易卡在等待状态。

const responseResult = await ukeySdk.uiResponse(response);

字段

常见入参(CommonParams)

  • type - 需要传入 string。类型:ui-receive_pinui-receive_passphrase
  • payload - 需要传入 object。内容

回传 PIN

ukeySdk.uiResponse({
type: UI_RESPONSE.RECEIVE_PIN,
payload: ${pin_value},
});
  • 软件端 PIN 输入时,pin_value 应为盲键盘映射后的值。
  • 如果想把 PIN 留在设备端处理,就把 payload 写成 @@UKEY_INPUT_PIN_IN_DEVICE

回传口令

ukeySdk.uiResponse({
type: UI_RESPONSE.RECEIVE_PASSPHRASE,
payload: {
value: ${passphrase_value},
passphraseOnDevice: false,
save: false,
},
});
  • 如果要让 Passphrase 在设备侧完成,就把 value 清空,并将 passphraseOnDevice 设为 true
  • 如果在软件界面输入,请根据产品设计决定是否使用 save 做当前会话缓存。