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');

Методы

Метод Тип возвращаемого значения Краткое описание
add Event Action(eventAction) Widget Добавляет действие события, которое можно выполнить с виджетом.
set Field Name(fieldName) Text Input Устанавливает ключ, идентифицирующий это текстовое поле ввода в объекте события, который генерируется при взаимодействии с пользовательским интерфейсом.
set Hint(hint) Text Input Устанавливает подсказку для текстового поля ввода.
set Host App Data Source(hostAppDataSource) Text Input Задает источник данных из приложений Google Workspace.
set Id(id) Widget Задает уникальный идентификатор, используемый для идентификации виджета, подлежащего изменению.
set Input Mode(inputMode) Text Input Определяет, поддерживает ли это текстовое поле ввода вставку переменных.
set Multiline(multiline) Text Input Определяет, будет ли введенный текст отображаться в одну или несколько строк.
set On Change Action(action) Text Input Задает действие, которое будет выполняться при изменении значения в поле ввода текста.
set Suggestions(suggestions) Text Input Задает варианты автозаполнения для текстового поля.
set Suggestions Action(suggestionsAction) Text Input Устанавливает действие обратного вызова для получения подсказок на основе пользовательского ввода для автозаполнения.
set Title(title) Text Input Задает заголовок, который будет отображаться над полем ввода.
set Validation(validation) Text Input Задает правило проверки для этого виджета.
set Value(value) Text Input Задает предварительно заполненное значение, которое будет введено в поле ввода.
set Visibility(visibility) Widget Задает видимость виджета.

Подробная документация

addEventAction(eventAction)

Добавляет действие события, которое можно выполнить с виджетом.

Параметры

Имя Тип Описание
event Action Event Action Необходимо добавить Event Action .

Возвращаться

Widget — Объект для создания цепочек.

setFieldName(fieldName)

Задает ключ, идентифицирующий это текстовое поле ввода в объекте события, генерируемом при взаимодействии с пользовательским интерфейсом. Не виден пользователю. Обязателен, должен быть уникальным.

Параметры

Имя Тип Описание
field Name String Ключ, используемый для идентификации данного входного сигнала.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setHint(hint)

Задает подсказку для текстового поля ввода. Используется для предоставления пользователю дополнительных указаний о том, что нужно ввести. Например, подсказка может описывать форматирование ("xxx-xxx-xxxx") для поля ввода номера телефона.

Параметры

Имя Тип Описание
hint String Текстовая подсказка, отображаемая под полем ввода. Этот текст всегда виден.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setHostAppDataSource(hostAppDataSource)

Задает источник данных из приложений Google Workspace. В настоящее время поддерживаются пользователи и чаты.

Доступно только для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Параметры

Имя Тип Описание
host App Data Source Host App Data Source Источник данных.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setId(id)

Задает уникальный идентификатор, используемый для идентификации виджета, который необходимо изменить. Изменение виджетов поддерживается только в дополнениях.

Параметры

Имя Тип Описание
id String Идентификатор виджета, ограниченный 64 символами и в формате `[a-zA-Z0-9-]+`.

Возвращаться

Widget — этот объект используется для создания цепочек вызовов.

setInputMode(inputMode)

Определяет, поддерживает ли это текстовое поле ввода вставку переменных.

Доступно только для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Параметры

Имя Тип Описание
input Mode Text Input Mode Для ввода текста в это поле используется тип RICH_TEXT, поддерживающий вставку переменных.

Возвращаться

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

Параметры

Имя Тип Описание
suggestions Action Action Действие, которое получает предложения по данному входному параметру.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setTitle(title)

Задает заголовок, который будет отображаться над полем ввода. Обязательно для заполнения.

Параметры

Имя Тип Описание
title String Текстовая метка для этого поля ввода.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setValidation(validation)

Задает правило проверки для этого виджета.

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 Правило проверки для этого виджета Text Input .

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setValue(value)

Задает предварительно заполненное значение, которое будет введено в поле ввода.

Параметры

Имя Тип Описание
value String Значение по умолчанию, помещаемое во входные данные. В параметрах обратного вызова формы оно всегда представляется в виде строки.

Возвращаться

TextInput — Этот объект используется для создания цепочек вызовов.

setVisibility(visibility)

Задает видимость виджета. Значение по умолчанию — `VISIBLE`.

Параметры

Имя Тип Описание
visibility Visibility Visibility виджета.

Возвращаться

Widget — Объект для создания цепочек.