Class SelectionInput

ВыборВвод

Поле ввода, позволяющее выбирать между набором предопределенных параметров.

Доступно для дополнений Google Workspace и приложений Google Chat.

var checkboxGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.CHECK_BOX)
    .setTitle("A group of checkboxes. Multiple selections are allowed.")
    .setFieldName("checkbox_field")
    .addItem("checkbox one title", "checkbox_one_value", false)
    .addItem("checkbox two title", "checkbox_two_value", true)
    .addItem("checkbox three title", "checkbox_three_value", true)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleCheckboxChange"));

var radioGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.RADIO_BUTTON)
    .setTitle("A group of radio buttons. Only a single selection is allowed.")
    .setFieldName("checkbox_field")
    .addItem("radio button one title", "radio_one_value", true)
    .addItem("radio button two title", "radio_two_value", false)
    .addItem("radio button three title", "radio_three_value", false);

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description")
    .setMultiSelectMaxSelectedItems(3)
    .setMultiSelectMinQueryLength(1);

Методы

Метод Тип возврата Краткое описание
addItem(text, value, selected) SelectionInput Добавляет новый элемент, который можно выбрать.
addMultiSelectItem(text, value, selected, startIconUri, bottomText) SelectionInput Добавляет новый элемент, который можно выбрать, для меню с множественным выбором.
setExternalDataSource(action) SelectionInput Устанавливает внешний источник данных, например реляционную базу данных.
setFieldName(fieldName) SelectionInput Устанавливает ключ, который идентифицирует этот ввод выбора в объекте события, который создается при взаимодействии пользовательского интерфейса.
setMultiSelectMaxSelectedItems(maxSelectedItems) SelectionInput Устанавливает максимальное количество элементов, которые может выбрать пользователь.
setMultiSelectMinQueryLength(queryLength) SelectionInput Устанавливает количество текстовых символов, которые пользователь вводит перед тем, как приложение запрашивает автозаполнение и отображает предлагаемые элементы на карточке.
setOnChangeAction(action) SelectionInput Устанавливает Action , которое будет выполняться при каждом изменении входных данных выбора.
setPlatformDataSource(platformDataSource) SelectionInput Устанавливает источник данных из Google Workspace.
setTitle(title) SelectionInput Устанавливает заголовок, который будет отображаться перед полем ввода.
setType(type) SelectionInput Устанавливает тип этого входа.

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

addItem(text, value, selected)

Добавляет новый элемент, который можно выбрать.

Параметры

Имя Тип Описание
text Object Текст, который будет отображаться для этого элемента. Нестроковые примитивные аргументы автоматически преобразуются в строки.
value Object Входное значение формы, которое отправляется через обратный вызов. Нестроковые примитивные аргументы автоматически преобразуются в строки.
selected Boolean Выбран ли элемент по умолчанию. Если входные данные выбора принимают только одно значение (например, для переключателей или раскрывающегося меню), установите это поле только для одного элемента.

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

SelectionInput — Этот объект для цепочки.

addMultiSelectItem(text, value, selected, startIconUri, bottomText)

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

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Параметры

Имя Тип Описание
text Object Текст, который будет отображаться для этого элемента. Нестроковые примитивные аргументы автоматически преобразуются в строки.
value Object Входное значение формы, которое отправляется через обратный вызов. Нестроковые примитивные аргументы автоматически преобразуются в строки.
selected Boolean Выбран ли элемент по умолчанию. Если входные данные выбора принимают только одно значение (например, для переключателей или раскрывающегося меню), установите это поле только для одного элемента.
startIconUri Object В меню с множественным выбором URL-адрес значка отображается рядом с текстовым полем элемента. Поддерживает файлы PNG и JPEG.
bottomText Object Для меню с множественным выбором — текстовое описание или метка, отображаемая под текстовым полем элемента.

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

SelectionInput — Этот объект для цепочки.

setExternalDataSource(action)

Устанавливает внешний источник данных, например реляционную базу данных.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .setMultiSelectMaxSelectedItems(5)
    .setMultiSelectMinQueryLength(2)
    .setExternalDataSource(CardService.newAction().setFunctionName("getContacts"));

Параметры

Имя Тип Описание
action Action Внешний источник данных.

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

SelectionInput — Этот объект для цепочки.

setFieldName(fieldName)

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

Параметры

Имя Тип Описание
fieldName String Имя, которое нужно присвоить этому входу.

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

SelectionInput — Этот объект для цепочки.

setMultiSelectMaxSelectedItems(maxSelectedItems)

Устанавливает максимальное количество элементов, которые может выбрать пользователь.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMaxSelectedItems(3)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Параметры

Имя Тип Описание
maxSelectedItems Integer Максимальное количество предметов.

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

SelectionInput — Этот объект для цепочки.

setMultiSelectMinQueryLength(queryLength)

Устанавливает количество текстовых символов, которые пользователь вводит перед тем, как приложение запрашивает автозаполнение и отображает предлагаемые элементы на карточке.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMinQueryLength(1)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Параметры

Имя Тип Описание
queryLength Integer Количество текстовых символов.

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

SelectionInput — Этот объект для цепочки.

setOnChangeAction(action)

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

Параметры

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

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

SelectionInput — Этот объект для цепочки.

setPlatformDataSource(platformDataSource)

Устанавливает источник данных из Google Workspace. Используется для заполнения элементов в меню с множественным выбором.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .setPlatformDataSource(
       CardService.newPlatformDataSource()
         .setCommonDataSource(CardService.CommonDataSource.USER));
Доступно только для приложений Google Chat. Недоступно для дополнений Google Workspace.

Параметры

Имя Тип Описание
platformDataSource PlatformDataSource Источник данных.

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

SelectionInput — Этот объект для цепочки.

setTitle(title)

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

Параметры

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

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

SelectionInput — Этот объект для цепочки.

setType(type)

Устанавливает тип этого входа. По умолчанию стоит CHECKBOX .

Параметры

Имя Тип Описание
type SelectionInputType Тип выбора.

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

SelectionInput — Этот объект для цепочки.