Class SelectionInput

WybórDane wejściowe

Pole do wprowadzania danych, które umożliwia wybór spośród zestawu wstępnie zdefiniowanych opcji.

Obsługuje sprawdzanie poprawności przesyłania formularzy tylko w przypadku menu SelectionInputType.DROP_DOWNSelectionInputType.MULTI_SELECT. Gdy parametr Action.setAllWidgetsAreRequired(allWidgetsAreRequired) ma wartość true lub gdy 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 dla dodatków do Google Workspace i aplikacji 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
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 z wieloznacznym wyborem.
setExternalDataSource(action)SelectionInputUstawia zewnętrzne źródło danych, np. relacyjną bazę danych.
setFieldName(fieldName)SelectionInputUstawia klucz, który identyfikuje to źródło danych w obiekcie zdarzenia generowanym, gdy występuje interakcja z interfejsem użytkownika.
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 wprowadzić, zanim aplikacja prześle zapytanie do funkcji autouzupełniania i wyświetli sugerowane elementy na karcie.
setOnChangeAction(action)SelectionInputOkreśla działanie Action, które ma być wykonywane, gdy zmieni się wejście wyboru.
setPlatformDataSource(platformDataSource)SelectionInputUstawia źródło danych z Google Workspace.
setTitle(title)SelectionInputOkreśla tytuł, który ma być wyświetlany przed polem do wprowadzania danych.
setType(type)SelectionInputOkreśla typ tego wejścia.

Szczegółowa dokumentacja

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 niebędące 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 niebędące ciągami znaków są automatycznie konwertowane na ciągi znaków.
selectedBooleanOkreśla, czy element jest domyślnie zaznaczony. 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 łańcucha.


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

Dodaje nowy element, który można wybrać, w menu z wieloznacznym wyborem.

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 niebędące 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 niebędące ciągami znaków są automatycznie konwertowane na ciągi znaków.
selectedBooleanOkreśla, czy element jest domyślnie zaznaczony. Jeśli pole wyboru może zawierać tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu.
startIconUriObjectW przypadku menu z wieloma opcjami URL ikony wyświetlanej obok pola tekstowego elementu. Obsługuje pliki PNG i JPEG.
bottomTextObjectW przypadku menu z wieloma opcjami opis tekstowy lub etykieta wyświetlane pod polem tekstowym elementu.

Powrót

SelectionInput – ten obiekt do łańcucha.


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 łańcucha.


setFieldName(fieldName)

Ustawia klucz, który identyfikuje to źródło danych w obiekcie zdarzenia generowanym, gdy występuje interakcja z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagane, musi być unikalny.

Parametry

NazwaTypOpis
fieldNameStringNazwa do przypisania temu wejściu.

Powrót

SelectionInput – ten obiekt do łańcucha.


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 łańcucha.


setMultiSelectMinQueryLength(queryLength)

Określa liczbę znaków tekstowych, które użytkownik musi wpisać, zanim aplikacja prześle zapytanie do funkcji 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 łańcucha.


setOnChangeAction(action)

Określa działanie Action, które ma być wykonywane, gdy zmieni się wejście wyboru.

Parametry

NazwaTypOpis
actionActionDziałanie do wykonania.

Powrót

SelectionInput – ten obiekt do łańcucha.


setPlatformDataSource(platformDataSource)

Ustawia źródło danych z Google Workspace. Służy do wypełniania elementów 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 Google Workspace.

Parametry

NazwaTypOpis
platformDataSourcePlatformDataSourceŹródło danych.

Powrót

SelectionInput – ten obiekt do łańcucha.


setTitle(title)

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

Parametry

NazwaTypOpis
titleStringTytuł pola danych.

Powrót

SelectionInput – ten obiekt do łańcucha.


setType(type)

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

Parametry

NazwaTypOpis
typeSelectionInputTypeTyp wyboru.

Powrót

SelectionInput – ten obiekt do łańcucha.