Class TextInput

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ввод текста

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

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