Class SelectionInput

SelectionInput

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

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

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 przypadku menu wielokrotnego wyboru.
setExternalDataSource(action)SelectionInputKonfiguruje zewnętrzne źródło danych, takie jak relacyjna baza danych.
setFieldName(fieldName)SelectionInputUstawia klucz identyfikujący te dane wejściowe w obiekcie zdarzenia generowanym podczas w interfejsie 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 wpisze, zanim zapytanie z aplikacji zostanie uzupełnione wyświetla sugerowane elementy na karcie.
setOnChangeAction(action)SelectionInputUstawia działanie Action, które ma być wykonywane po każdej zmianie wyboru.
setPlatformDataSource(platformDataSource)SelectionInputKonfiguruje źródło danych z Google Workspace.
setTitle(title)SelectionInputUstawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych.
setType(type)SelectionInputOkreśla typ danych wejściowych.

Szczegółowa dokumentacja

addItem(text, value, selected)

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

Parametry

NazwaTypOpis
textObjectTekst, który będzie wyświetlany w przypadku tego elementu. Argumenty podstawowe niebędące ciągami są konwertowane na ciągi tekstowe.
valueObjectWartość wejściowa formularza wysyłana w wywołaniu zwrotnym. Argumenty podstawowe bez ciągu znaków są automatycznie konwertowane na ciągi tekstowe.
selectedBooleanOkreśla, czy element jest wybierany domyślnie. Jeśli pole wyboru akceptuje tylko jedną wartość (np. opcji lub menu rozwijanego), ustaw to pole tylko dla jednego elementu.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


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

Dodaje nowy element, który można wybrać w przypadku 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 będzie wyświetlany w przypadku tego elementu. Argumenty podstawowe niebędące ciągami są konwertowane na ciągi tekstowe.
valueObjectWartość wejściowa formularza wysyłana w wywołaniu zwrotnym. Argumenty podstawowe bez ciągu znaków są automatycznie konwertowane na ciągi tekstowe.
selectedBooleanOkreśla, czy element jest wybierany domyślnie. Jeśli pole wyboru akceptuje tylko jedną wartość (np. opcji lub menu rozwijanego), ustaw to pole tylko dla jednego elementu.
startIconUriObjectW przypadku menu wielokrotnego wyboru adres URL ikony wyświetlanej obok elementu polu tekstowym. Obsługuje pliki PNG i JPEG.
bottomTextObjectw przypadku menu wielokrotnego wyboru opis tekstowy lub etykieta widoczna pod przyciskiem pola tekstowego elementu.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


setExternalDataSource(action)

Konfiguruje zewnętrzne źródło danych, takie jak relacyjna baza 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 – obiekt do tworzenia łańcuchów.


setFieldName(fieldName)

Ustawia klucz identyfikujący te dane wejściowe w obiekcie zdarzenia generowanym podczas w interfejsie użytkownika. Niewidoczne dla użytkownika. Wymagana, musi być unikalna.

Parametry

NazwaTypOpis
fieldNameStringNazwa do przypisania do tych danych wejściowych.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


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 – obiekt do tworzenia łańcuchów.


setMultiSelectMinQueryLength(queryLength)

Określa liczbę znaków tekstowych, które użytkownik wpisze, zanim zapytanie z aplikacji zostanie uzupełnione wyświetla 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 tekstu.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


setOnChangeAction(action)

Ustawia działanie Action, które ma być wykonywane po każdej zmianie wyboru.

Parametry

NazwaTypOpis
actionActionDziałanie do wykonania.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


setPlatformDataSource(platformDataSource)

Konfiguruje ź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 aplikacjach Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.

Parametry

NazwaTypOpis
platformDataSourcePlatformDataSourceŹródło danych.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.


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 – obiekt do tworzenia łańcuchów.


setType(type)

Określa typ danych wejściowych. Domyślna wartość to CHECKBOX.

Parametry

NazwaTypOpis
typeSelectionInputTypeTyp wyboru.

Powrót

SelectionInput – obiekt do tworzenia łańcuchów.