Class TextInput

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
TextInput

一个接受文本输入的输入字段微件。

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)

设置文本输入提示。用于为用户提供额外的输入指导。例如,一条提示可以描述电话号码字段的格式 (“qu-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 - 此对象,用于实现链式连接。