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

Методы

Метод Тип возврата Краткое описание
set Field Name(fieldName) Text Input Устанавливает ключ, который идентифицирует этот текстовый ввод в объекте события, который генерируется при взаимодействии с пользовательским интерфейсом.
set Hint(hint) Text Input Устанавливает подсказку для ввода текста.
set Host App Data Source(hostAppDataSource) Text Input Устанавливает источник данных из приложений Google Workspace.
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 Field Name(fieldName)

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

Параметры

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

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

Text Input — этот объект предназначен для объединения в цепочку.

set Hint(hint)

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

Параметры

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

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

Text Input — этот объект предназначен для объединения в цепочку.

set Host App Data Source(hostAppDataSource)

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

Доступно только в рамках программы Gemini Alpha для дополнений Google Workspace, расширяющих Google Workspace Flows.

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 Источник данных.

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

Text Input — этот объект предназначен для объединения в цепочку.

set Multiline(multiline)

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

Параметры

Имя Тип Описание
multiline Boolean Многострочная настройка.

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

Text Input — этот объект предназначен для объединения в цепочку.

set On Change Action(action)

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

Параметры

Имя Тип Описание
action Action Действия, которые необходимо предпринять.

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

Text Input — этот объект предназначен для объединения в цепочку.

set Suggestions(suggestions)

Устанавливает предложения для автодополнения в текстовом поле.

Параметры

Имя Тип Описание
suggestions Suggestions Сборник предложений по использованию.

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

Text Input — этот объект предназначен для объединения в цепочку.

set Suggestions Action(suggestionsAction)

Устанавливает действие обратного вызова для получения подсказок на основе пользовательского ввода для автодополнения. Параметр Action должен указывать функцию обратного вызова, возвращающую объект Suggestions Response .

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 Действие, которое извлекает предложения для этого ввода.

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

Text Input — этот объект предназначен для объединения в цепочку.

set Title(title)

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

Параметры

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

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

Text Input — этот объект предназначен для объединения в цепочку.

set Validation(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 .

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

Text Input — этот объект предназначен для объединения в цепочку.

set Value(value)

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

Параметры

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

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

Text Input — этот объект предназначен для объединения в цепочку.