Class TextInput

TextInput

接受文本输入的输入字段 widget。

适用于 Google Workspace 插件和 Google Chat 应用。

var textInput = CardService.newTextInput()
    .setFieldName("text_input_form_input_key")
    .setTitle("Text input title")
    .setHint("Text input hint");

方法

方法返回类型简介
setFieldName(fieldName)TextInput在存在界面互动时生成的事件对象中设置用于标识此文本输入的键。
setHint(hint)TextInput设置文本输入的提示。
setMultiline(multiline)TextInput设置输入文本是显示在一行还是多行。
setOnChangeAction(action)TextInput设置每当文本输入发生更改时要执行的操作。
setSuggestions(suggestions)TextInput设置文本字段中的自动补全建议。
setSuggestionsAction(suggestionsAction)TextInput设置回调操作,以根据用户输入获取自动填充建议。
setTitle(title)TextInput设置在输入字段上方显示的标题。
setValue(value)TextInput设置要在输入字段中设置的预填充值。

详细文档

setFieldName(fieldName)

在存在界面互动时生成的事件对象中设置用于标识此文本输入的键。对用户不可见。必填,必须是唯一的。

参数

名称类型说明
fieldNameString用于标识此输入的键。

弃踢回攻

TextInput - 此对象,用于链接。


setHint(hint)

设置文本输入的提示。用于为用户提供有关输入内容的额外指导。例如,提示可以描述电话号码字段的格式(“xxx-xxx-xxxx”)。

参数

名称类型说明
hintString在输入字段下方显示的文本提示。此文字始终可见。

弃踢回攻

TextInput - 此对象,用于链接。


setMultiline(multiline)

设置输入文本是显示在一行还是多行。

参数

名称类型说明
multilineBoolean多行设置。

弃踢回攻

TextInput - 此对象,用于链接。


setOnChangeAction(action)

设置每当文本输入发生更改时要执行的操作。

参数

名称类型说明
actionAction要执行的操作。

弃踢回攻

TextInput - 此对象,用于链接。


setSuggestions(suggestions)

设置文本字段中的自动补全建议。

参数

名称类型说明
suggestionsSuggestions要使用的建议的集合。

弃踢回攻

TextInput - 此对象,用于链接。


setSuggestionsAction(suggestionsAction)

设置回调操作,以根据用户输入获取自动填充建议。Action 参数必须指定会返回 SuggestionsResponse 对象的回调函数。

var action = CardService.newAction()
    .setFunctionName('suggestionCallback')
    .setParameters({'numSuggestions': 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  var suggestions = CardService.newSuggestions();
  var numSuggestions = parseInt(e.parameter['numSuggestions']);
  for(var i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion('Suggestion ' + i);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

参数

名称类型说明
suggestionsActionAction获取此输入的建议的操作。

弃踢回攻

TextInput - 此对象,用于链接。


setTitle(title)

设置在输入字段上方显示的标题。必填。

参数

名称类型说明
titleString此输入内容的文本标签。

弃踢回攻

TextInput - 此对象,用于链接。


setValue(value)

设置要在输入字段中设置的预填充值。

参数

名称类型说明
valueString输入中的默认值。它始终在表单回调参数中表示为字符串。

弃踢回攻

TextInput - 此对象,用于链接。