Pole do wprowadzania danych, które umożliwia wybór spośród 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
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
addItem(text, value, selected) | SelectionInput | Dodaje nowy element, który można wybrać. |
addMultiSelectItem(text, value, selected, startIconUri, bottomText) | SelectionInput | Dodaje nowy element, który można wybrać w przypadku menu wielokrotnego wyboru. |
setExternalDataSource(action) | SelectionInput | Ustawia zewnętrzne źródło danych, na przykład relacyjną bazę danych. |
setFieldName(fieldName) | SelectionInput | Ustawia klucz, który identyfikuje wybrane dane wejściowe w obiekcie zdarzenia generowanym podczas interakcji interfejsu użytkownika. |
setMultiSelectMaxSelectedItems(maxSelectedItems) | SelectionInput | Określa maksymalną liczbę elementów, które użytkownik może wybrać. |
setMultiSelectMinQueryLength(queryLength) | SelectionInput | Określa liczbę znaków wpisanych przez użytkownika, zanim zapytanie w aplikacji zostanie automatycznie uzupełnione, i wyświetli na karcie sugerowane elementy. |
setOnChangeAction(action) | SelectionInput | Ustawia Action , który ma być wykonywany po każdej zmianie danych wejściowych. |
setPlatformDataSource(platformDataSource) | SelectionInput | Ustawia źródło danych z Google Workspace. |
setTitle(title) | SelectionInput | Ustawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych. |
setType(type) | SelectionInput | Określa typ danych wejściowych. |
Szczegółowa dokumentacja
addItem(text, value, selected)
Dodaje nowy element, który można wybrać.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | Object | Tekst, który będzie wyświetlany dla tego elementu. Podstawowe argumenty inne niż ciągi są automatycznie konwertowane na ciągi znaków. |
value | Object | Wartość wejściowa formularza wysyłana przez wywołanie zwrotne. Podstawowe argumenty inne niż ciągi są automatycznie konwertowane na ciągi znaków. |
selected | Boolean | Określa, czy element jest wybrany domyślnie. Jeśli dane wejściowe wyboru akceptują tylko jedną wartość (np. w przypadku przycisków lub menu), ustaw to pole tylko dla 1 elementu. |
Powroty
SelectionInput
– ten 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
Nazwa | Typ | Opis |
---|---|---|
text | Object | Tekst, który będzie wyświetlany dla tego elementu. Podstawowe argumenty inne niż ciągi są automatycznie konwertowane na ciągi znaków. |
value | Object | Wartość wejściowa formularza wysyłana przez wywołanie zwrotne. Podstawowe argumenty inne niż ciągi są automatycznie konwertowane na ciągi znaków. |
selected | Boolean | Określa, czy element jest wybrany domyślnie. Jeśli dane wejściowe wyboru akceptują tylko jedną wartość (np. w przypadku przycisków lub menu), ustaw to pole tylko dla 1 elementu. |
startIconUri | Object | W przypadku menu wyboru wielokrotnego jest to adres URL ikony wyświetlanej obok pola tekstowego elementu. Obsługuje pliki PNG i JPEG. |
bottomText | Object | W przypadku menu wyboru wielokrotnego jest to opis tekstowy lub etykieta wyświetlana pod polem tekstowym elementu. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setExternalDataSource(action)
Ustawia zewnętrzne źródło danych, na przykład 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
Nazwa | Typ | Opis |
---|---|---|
action | Action | Zewnętrzne źródło danych. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setFieldName(fieldName)
Ustawia klucz, który identyfikuje wybrane dane wejściowe w obiekcie zdarzenia generowanym podczas interakcji interfejsu użytkownika. Niewidoczne dla użytkownika. Wymagane, nie może się powtarzać.
Parametry
Nazwa | Typ | Opis |
---|---|---|
fieldName | String | Nazwa do przypisania do tych danych wejściowych. |
Powroty
SelectionInput
– ten 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
Nazwa | Typ | Opis |
---|---|---|
maxSelectedItems | Integer | Maksymalna liczba elementów. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setMultiSelectMinQueryLength(queryLength)
Określa liczbę znaków wpisanych przez użytkownika, zanim zapytanie w aplikacji zostanie automatycznie uzupełnione, i wyświetli na karcie sugerowane elementy.
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
Nazwa | Typ | Opis |
---|---|---|
queryLength | Integer | Liczba znaków tekstowych. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setOnChangeAction(action)
Ustawia Action
, który ma być wykonywany po każdej zmianie danych wejściowych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
action | Action | Działanie do wykonania. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
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));To ustawienie jest dostępne tylko w przypadku aplikacji Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
Parametry
Nazwa | Typ | Opis |
---|---|---|
platformDataSource | PlatformDataSource | Źródło danych. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setTitle(title)
Ustawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
title | String | Tytuł pola do wprowadzania danych. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.
setType(type)
Określa typ danych wejściowych. Domyślna wartość to CHECKBOX
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
type | SelectionInputType | Typ wyboru. |
Powroty
SelectionInput
– ten obiekt do tworzenia łańcuchów.