Class SelectionInput

WybórDane wejściowe

Pole do wprowadzania danych, które umożliwia wybór spośród określonych opcji.

Obsługuje sprawdzanie poprawności przesłania formularza tylko w przypadku menu SelectionInputType.DROP_DOWNSelectionInputType.MULTI_SELECT. Gdy parametr Action.setAllWidgetsAreRequired(allWidgetsAreRequired) ma wartość true lub ten widżet jest określony za pomocą parametru Action.addRequiredWidget(requiredWidget), działanie przesyłania jest blokowane, chyba że zostanie wybrana wartość.

Dostępne w przypadku dodatków do Google Workspace i aplikacji do 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);

Metody

MetodaZwracany typKrótki opis
addDataSourceConfig(dataSourceConfig)SelectionInputUstawia konfiguracje źródła danych dla kontrolki wyboru.
addEventAction(eventAction)WidgetDodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
addItem(text, value, selected)SelectionInputDodaje nowy element, który można wybrać.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputDodaje nowy element, który można wybrać w menu wielokrotnego wyboru.
setExternalDataSource(action)SelectionInputUstawia zewnętrzne źródło danych, np. relacyjną bazę danych.
setFieldName(fieldName)SelectionInputUstawia klucz, który identyfikuje to pole wyboru w obiekcie zdarzenia generowanym podczas interakcji z interfejsem.
setId(id)WidgetUstawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputOkreśla maksymalną liczbę elementów, które użytkownik może wybrać.
setMultiSelectMinQueryLength(queryLength)SelectionInputOkreśla liczbę znaków tekstowych, które użytkownik musi wpisać, zanim aplikacja wyśle zapytanie do autouzupełniania i wyświetli sugerowane elementy na karcie.
setOnChangeAction(action)SelectionInputUstawia Action, które ma być wykonywane za każdym razem, gdy zmieni się dane wejściowe wyboru.
setPlatformDataSource(platformDataSource)SelectionInputUstawia źródło danych z Google Workspace.
setTitle(title)SelectionInputUstawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych.
setType(type)SelectionInputUstawia typ tego wejścia.
setVisibility(visibility)WidgetUstawia widoczność widżetu.

Szczegółowa dokumentacja

addDataSourceConfig(dataSourceConfig)

Ustawia konfiguracje źródła danych dla kontrolki wyboru. To pole zapewnia bardziej szczegółową kontrolę nad źródłem danych. To pole jest opcjonalne.

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setDataSourceConfig(
            CardService.newDataSourceConfig().setPlatformDataSource(
                CardService.newPlatformDataSource().setCommonDataSource(
                    CardService.CommonDataSource.USER,
                )
            )
        );

Parametry

NazwaTypOpis
dataSourceConfigDataSourceConfigKonfiguracja źródła danych, która ma zostać zastosowana do danych wejściowych wyboru.

Powrót

SelectionInput – ten obiekt do łączenia.


addEventAction(eventAction)

Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.

Parametry

NazwaTypOpis
eventActionEventActionEventAction do dodania.

Powrót

Widget – obiekt do łączenia.


addItem(text, value, selected)

Dodaje nowy element, który można wybrać.

Parametry

NazwaTypOpis
textObjectTekst, który ma być wyświetlany w przypadku tego elementu. Argumenty pierwotne, które nie są ciągami znaków, są automatycznie konwertowane na ciągi znaków.
valueObjectWartość wprowadzona w formularzu, która jest wysyłana za pomocą wywołania zwrotnego. Argumenty pierwotne inne niż ciągi znaków są automatycznie konwertowane na ciągi znaków.
selectedBooleanCzy element jest domyślnie wybrany. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu.

Powrót

SelectionInput – ten obiekt do łączenia.


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

Dodaje nowy element, który można wybrać w menu wielokrotnego wyboru.

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

Parametry

NazwaTypOpis
textObjectTekst, który ma być wyświetlany w przypadku tego elementu. Argumenty pierwotne, które nie są ciągami znaków, są automatycznie konwertowane na ciągi znaków.
valueObjectWartość wprowadzona w formularzu, która jest wysyłana za pomocą wywołania zwrotnego. Argumenty pierwotne inne niż ciągi znaków są automatycznie konwertowane na ciągi znaków.
selectedBooleanCzy element jest domyślnie wybrany. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu.
startIconUriObjectW przypadku menu wielokrotnego wyboru adres URL ikony wyświetlanej obok pola tekstowego elementu. Obsługuje pliki PNG i JPEG.
bottomTextObjectW przypadku menu wielokrotnego wyboru jest to opis tekstowy lub etykieta wyświetlana pod polem tekstowym elementu.

Powrót

SelectionInput – ten obiekt do łączenia.


setExternalDataSource(action)

Ustawia zewnętrzne źródło danych, np. relacyjną bazę danych.

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

Parametry

NazwaTypOpis
actionActionZewnętrzne źródło danych.

Powrót

SelectionInput – ten obiekt do łączenia.


setFieldName(fieldName)

Ustawia klucz, który identyfikuje to pole wyboru w obiekcie zdarzenia generowanym podczas interakcji z interfejsem. Niewidoczny dla użytkownika. Wymagany, musi być unikalny.

Parametry

NazwaTypOpis
fieldNameStringNazwa, którą chcesz przypisać do tego wejścia.

Powrót

SelectionInput – ten obiekt do łączenia.


setId(id)

Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. Modyfikacja widżetu jest obsługiwana tylko w dodatkach.

Parametry

NazwaTypOpis
idStringIdentyfikator widżetu, który może mieć maksymalnie 64 znaki i musi być zgodny z formatem `[a-zA-Z0-9-]+`.

Powrót

Widget – ten obiekt do łączenia.


setMultiSelectMaxSelectedItems(maxSelectedItems)

Określa maksymalną liczbę elementów, które użytkownik może wybrać.

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

Parametry

NazwaTypOpis
maxSelectedItemsIntegerMaksymalna liczba elementów.

Powrót

SelectionInput – ten obiekt do łączenia.


setMultiSelectMinQueryLength(queryLength)

Określa liczbę znaków tekstowych, które użytkownik musi wpisać, zanim aplikacja wyśle zapytanie do autouzupełniania i wyświetli sugerowane elementy na karcie.

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

Parametry

NazwaTypOpis
queryLengthIntegerLiczba znaków tekstowych.

Powrót

SelectionInput – ten obiekt do łączenia.


setOnChangeAction(action)

Ustawia Action, które ma być wykonywane za każdym razem, gdy zmieni się dane wejściowe wyboru.

Parametry

NazwaTypOpis
actionActionDziałanie do wykonania.

Powrót

SelectionInput – ten obiekt do łączenia.


setPlatformDataSource(platformDataSource)

Ustawia źródło danych z Google Workspace. Służy do wypełniania pozycji w menu wielokrotnego wyboru.

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków do Google Workspace.

Parametry

NazwaTypOpis
platformDataSourcePlatformDataSourceŹródło danych.

Powrót

SelectionInput – ten obiekt do łączenia.


setTitle(title)

Ustawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych.

Parametry

NazwaTypOpis
titleStringTytuł pola do wprowadzania danych.

Powrót

SelectionInput – ten obiekt do łączenia.


setType(type)

Ustawia typ tego wejścia. Domyślna wartość to CHECKBOX.

Parametry

NazwaTypOpis
typeSelectionInputTypeTyp wyboru.

Powrót

SelectionInput – ten obiekt do łączenia.


setVisibility(visibility)

Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.

Parametry

NazwaTypOpis
visibilityVisibilityVisibility widżetu.

Powrót

Widget – obiekt do łączenia.