Class TextInput

文本输入

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

支持表单提交验证。如果 Action.setAllWidgetsAreRequired(allWidgetsAreRequired) 设置为 true 或通过 Action.addRequiredWidget(requiredWidget) 指定此微件，则除非输入值，否则系统会阻止提交操作。

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

const 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	设置要在输入字段上方显示的标题。
setValidation(validation)	TextInput	为此 widget 设置验证规则。
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 对象的回调函数。

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

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

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

参数

名称	类型	说明
suggestionsAction	Action	用于提取此输入建议的操作。

返回

TextInput - 此对象，用于链式调用。

---

setTitle(title)

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

参数

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

返回

TextInput - 此对象，用于链式调用。

---

setValidation(validation)

为此 widget 设置验证规则。

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

参数

名称	类型	说明
validation	Validation	此 TextInput 微件的验证规则。

返回

TextInput - 此对象，用于链式调用。

---

setValue(value)

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

参数

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

返回

TextInput - 此对象，用于链式调用。