Eingabefeld, über das vordefinierte Optionen ausgewählt werden können.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
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);
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addItem(text, value, selected) | SelectionInput | Fügt ein neues Element hinzu, das ausgewählt werden kann. |
addMultiSelectItem(text, value, selected, startIconUri, bottomText) | SelectionInput | Fügt ein neues Element hinzu, das in Menüs mit Mehrfachauswahl ausgewählt werden kann. |
setExternalDataSource(action) | SelectionInput | Legt eine externe Datenquelle fest, z. B. eine relationale Datenbank. |
setFieldName(fieldName) | SelectionInput | Legt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das generiert wird, wenn erfolgt eine Interaktion auf der Benutzeroberfläche. |
setMultiSelectMaxSelectedItems(maxSelectedItems) | SelectionInput | Legt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann. |
setMultiSelectMinQueryLength(queryLength) | SelectionInput | Legt die Anzahl der Textzeichen fest, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt und werden vorgeschlagene Elemente auf der Karte angezeigt. |
setOnChangeAction(action) | SelectionInput | Legt fest, dass ein Action ausgeführt wird, wenn sich die Auswahleingabe ändert. |
setPlatformDataSource(platformDataSource) | SelectionInput | Legt eine Datenquelle aus Google Workspace fest. |
setTitle(title) | SelectionInput | Legt fest, dass der Titel vor dem Eingabefeld angezeigt wird. |
setType(type) | SelectionInput | Legt den Typ dieser Eingabe fest. |
Detaillierte Dokumentation
addItem(text, value, selected)
Fügt ein neues Element hinzu, das ausgewählt werden kann.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | Object | Der Text, der für dieses Element angezeigt werden soll. Primitive Nicht-String-Argumente werden in automatisch ändern. |
value | Object | Der Formulareingabewert, der über den Callback gesendet wird. Primitive Nicht-String-Argumente automatisch in Strings konvertiert. |
selected | Boolean | Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn bei der Auswahl nur einen Wert (z. B. für Optionsfelder oder ein Dropdown-Menü), legen Sie dieses Feld nur für ein Element fest. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)
Fügt ein neues Element hinzu, das in Menüs mit Mehrfachauswahl ausgewählt werden kann.
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");
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | Object | Der Text, der für dieses Element angezeigt werden soll. Primitive Nicht-String-Argumente werden in automatisch ändern. |
value | Object | Der Formulareingabewert, der über den Callback gesendet wird. Primitive Nicht-String-Argumente automatisch in Strings konvertiert. |
selected | Boolean | Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn bei der Auswahl nur einen Wert (z. B. für Optionsfelder oder ein Dropdown-Menü), legen Sie dieses Feld nur für ein Element fest. |
startIconUri | Object | Bei Menüs mit Mehrfachauswahl wird die URL für das Symbol neben der Option Textfeld ein. Unterstützt PNG- und JPEG-Dateien. |
bottomText | Object | Bei Menüs mit Mehrfachauswahl wird eine Textbeschreibung oder ein Label unterhalb des in das Textfeld ein. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setExternalDataSource(action)
Legt eine externe Datenquelle fest, z. B. eine relationale Datenbank.
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"));
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die externe Datenquelle. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setFieldName(fieldName)
Legt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das generiert wird, wenn erfolgt eine Interaktion auf der Benutzeroberfläche. Für den Nutzer nicht sichtbar. Erforderlich, muss eindeutig sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
fieldName | String | Der Name, der diesem Eingang zugewiesen werden soll. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setMultiSelectMaxSelectedItems(maxSelectedItems)
Legt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann.
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");
Parameter
Name | Typ | Beschreibung |
---|---|---|
maxSelectedItems | Integer | Die maximale Anzahl von Elementen. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setMultiSelectMinQueryLength(queryLength)
Legt die Anzahl der Textzeichen fest, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt und werden vorgeschlagene Elemente auf der Karte angezeigt.
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");
Parameter
Name | Typ | Beschreibung |
---|---|---|
queryLength | Integer | Die Anzahl der Textzeichen. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setOnChangeAction(action)
Legt fest, dass ein Action
ausgeführt wird, wenn sich die Auswahleingabe ändert.
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die erforderliche Aktion. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setPlatformDataSource(platformDataSource)
Legt eine Datenquelle aus Google Workspace fest. Wird zum Füllen von Elementen in einem Mehrfachauswahlmenü verwendet.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName("contacts") .setTitle("Selected contacts") .setPlatformDataSource( CardService.newPlatformDataSource() .setCommonDataSource(CardService.CommonDataSource.USER));Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.
Parameter
Name | Typ | Beschreibung |
---|---|---|
platformDataSource | PlatformDataSource | Die Datenquelle. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setTitle(title)
Legt fest, dass der Titel vor dem Eingabefeld angezeigt wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Eingabefelds. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.
setType(type)
Legt den Typ dieser Eingabe fest. Die Standardeinstellung ist CHECKBOX
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
type | SelectionInputType | Der Auswahltyp. |
Rückflug
SelectionInput
: Dieses Objekt zur Verkettung.