Эта страница переведена с помощью Cloud Translation API.

Class SelectionInput

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

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

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

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

Методы

Метод	Тип возврата	Краткое описание
`add Item(text, value, selected)`	`Selection Input`	Добавляет новый элемент, который можно выбрать.
`add Multi Select Item(text, value, selected, startIconUri, bottomText)`	`Selection Input`	Добавляет новый элемент, который можно выбрать, для меню с множественным выбором.
`set External Data Source(action)`	`Selection Input`	Устанавливает внешний источник данных, например реляционную базу данных.
`set Field Name(fieldName)`	`Selection Input`	Устанавливает ключ, который идентифицирует этот ввод выбора в объекте события, который создается при взаимодействии пользовательского интерфейса.
`set Multi Select Max Selected Items(maxSelectedItems)`	`Selection Input`	Устанавливает максимальное количество элементов, которые может выбрать пользователь.
`set Multi Select Min Query Length(queryLength)`	`Selection Input`	Устанавливает количество текстовых символов, которые пользователь вводит перед тем, как приложение запрашивает автозаполнение и отображает предлагаемые элементы на карточке.
`set On Change Action(action)`	`Selection Input`	Устанавливает `Action` , которое будет выполняться при каждом изменении входных данных выбора.
`set Platform Data Source(platformDataSource)`	`Selection Input`	Устанавливает источник данных из Google Workspace.
`set Title(title)`	`Selection Input`	Устанавливает заголовок, который будет отображаться перед полем ввода.
`set Type(type)`	`Selection Input`	Устанавливает тип этого входа.

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

`add Item(text, value, selected)`

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

Параметры

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

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

Selection Input — этот объект для цепочки.

`add Multi Select Item(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`	Выбран ли элемент по умолчанию. Если входные данные выбора принимают только одно значение (например, для переключателей или раскрывающегося меню), установите это поле только для одного элемента.
`start Icon Uri`	`Object`	В меню с множественным выбором URL-адрес значка отображается рядом с текстовым полем элемента. Поддерживает файлы PNG и JPEG.
`bottom Text`	`Object`	Для меню с множественным выбором — текстовое описание или метка, отображаемая под текстовым полем элемента.

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

Selection Input — этот объект для цепочки.

`set External Data Source(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`	Внешний источник данных.

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

Selection Input — этот объект для цепочки.

`set Field Name(fieldName)`

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

Параметры

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

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

Selection Input — этот объект для цепочки.

`set Multi Select Max Selected Items(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',
        );

Параметры

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

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

Selection Input — этот объект для цепочки.

`set Multi Select Min Query Length(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',
        );

Параметры

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

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

Selection Input — этот объект для цепочки.

`set On Change Action(action)`

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

Параметры

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

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

Selection Input — этот объект для цепочки.

`set Platform Data Source(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.

Параметры

Имя	Тип	Описание
`platform Data Source`	`Platform Data Source`	Источник данных.

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

Selection Input — этот объект для цепочки.

`set Title(title)`

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

Параметры

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

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

Selection Input — этот объект для цепочки.

`set Type(type)`

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

Параметры

Имя	Тип	Описание
`type`	`Selection Input Type`	Тип выбора.

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

Selection Input — этот объект для цепочки.