Class TextInput

ТекстИнпут

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

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

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

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 — Этот объект для цепочки.