此页面由 Cloud Translation API 翻译。

Class TextInput

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

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)`

在存在界面互动时生成的事件对象中设置用于标识此文本输入的键。用户看不到。必需，并且必须是唯一的。

参数

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

返程

TextInput - 此对象，用于链接。

`setHint(hint)`

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

参数

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

返程

TextInput - 此对象，用于链接。

`setMultiline(multiline)`

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

参数

名称	类型	说明
`multiline`	`Boolean`	多行设置。

返程

TextInput - 此对象，用于链接。

`setOnChangeAction(action)`

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

参数

名称	类型	说明
`action`	`Action`	要执行的操作。

返程

TextInput - 此对象，用于链接。

`setSuggestions(suggestions)`

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

参数

名称	类型	说明
`suggestions`	`Suggestions`	要使用的建议的集合。

返程

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();
}

参数

名称	类型	说明
`suggestionsAction`	`Action`	针对此输入获取建议的操作。

返程

TextInput - 此对象，用于链接。

`setTitle(title)`

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

参数

名称	类型	说明
`title`	`String`	此输入的文本标签。

返程

TextInput - 此对象，用于链接。

`setValue(value)`

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

参数

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

返程

TextInput - 此对象，用于链接。