抖音开放平台Logo
控制台

tt.updateKeyboard
收藏
我的收藏

基础库 1.0.0 开始支持本方法,这是一个异步方法。

更新键盘,只有当键盘处于拉起状态时才会产生效果。

前提条件
业务背景
使用限制
注意事项
相关教程

语法

tt.updateKeyboard(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
valuestring
键盘输入框的当前值
1.0.0
successfunction
接口调用成功的回调函数
1.0.0
failfunction
接口调用失败的回调函数
1.0.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"updateKeyboard:ok"
1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"updateKeyboard:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.showKeyboard({
  defaultValue: "hello world",
  maxLength: 200,
  multiple: false,
  confirmHold: true,
  confirmType: "done",
  success: () => {
    setTimeout(() => {
      tt.updateKeyboard({
        value: "keyboard updated", // 键盘输入框的当前值
      });
    }, 2000);
  },
});