Class SelectionInput

AuswahlEingabe

Ein Eingabefeld, in dem eine Auswahl aus einer Reihe vordefinierter Optionen getroffen werden kann.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

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

Methoden

MethodeRückgabetypKurzbeschreibung
addItem(text, value, selected)SelectionInputHiermit wird ein neues Element hinzugefügt, das ausgewählt werden kann.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputFügen Sie ein neues Element hinzu, das in Menüs mit Mehrfachauswahl ausgewählt werden kann.
setExternalDataSource(action)SelectionInputLegt eine externe Datenquelle fest, z. B. eine relationale Datenbank.
setFieldName(fieldName)SelectionInputLegt den Schlüssel fest, der diese Auswahleingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputLegt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann.
setMultiSelectMinQueryLength(queryLength)SelectionInputLegt die Anzahl der Textzeichen fest, die ein Nutzer eingeben muss, bevor die App die automatische Vervollständigung abfragt und Vorschläge auf der Karte anzeigt.
setOnChangeAction(action)SelectionInputHiermit wird eine Action festgelegt, die ausgeführt wird, wenn sich die Auswahleingabe ändert.
setPlatformDataSource(platformDataSource)SelectionInputHiermit wird eine Datenquelle aus Google Workspace festgelegt.
setTitle(title)SelectionInputHier legen Sie den Titel fest, der vor dem Eingabefeld angezeigt werden soll.
setType(type)SelectionInputLegt den Typ dieser Eingabe fest.

Detaillierte Dokumentation

addItem(text, value, selected)

Hiermit wird ein neues Element hinzugefügt, das ausgewählt werden kann.

Parameter

NameTypBeschreibung
textObjectDer Text, der für dieses Element angezeigt werden soll. Nicht-String-Primärargumente werden automatisch in Strings konvertiert.
valueObjectDer Formulareingabewert, der über den Callback gesendet wird. Nicht-String-Primärargumente werden automatisch in Strings konvertiert.
selectedBooleanGibt an, ob das Element standardmäßig ausgewählt ist. Wenn für die Auswahl nur ein Wert zulässig ist (z. B. bei Optionsfeldern oder Drop-down-Menüs), legen Sie dieses Feld nur für einen Artikel fest.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


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

Fügen Sie 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

NameTypBeschreibung
textObjectDer Text, der für dieses Element angezeigt werden soll. Nicht-String-Primärargumente werden automatisch in Strings konvertiert.
valueObjectDer Formulareingabewert, der über den Callback gesendet wird. Nicht-String-Primärargumente werden automatisch in Strings konvertiert.
selectedBooleanGibt an, ob das Element standardmäßig ausgewählt ist. Wenn für die Auswahl nur ein Wert zulässig ist (z. B. bei Optionsfeldern oder Drop-down-Menüs), legen Sie dieses Feld nur für einen Artikel fest.
startIconUriObjectBei Menüs mit Mehrfachauswahl: die URL für das Symbol, das neben dem Textfeld des Artikels angezeigt wird. Unterstützt PNG- und JPEG-Dateien.
bottomTextObjectBei Menüs mit Mehrfachauswahl: Textbeschreibung oder Label, das unter dem Textfeld des Artikels angezeigt wird.

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

NameTypBeschreibung
actionActionDie 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 eine UI-Interaktion stattfindet. Nicht für den Nutzer sichtbar. Erforderlich, muss eindeutig sein.

Parameter

NameTypBeschreibung
fieldNameStringDer Name, der dieser Eingabe 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

NameTypBeschreibung
maxSelectedItemsIntegerDie maximale Anzahl der Elemente.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


setMultiSelectMinQueryLength(queryLength)

Legt die Anzahl der Textzeichen fest, die ein Nutzer eingeben muss, bevor die App die automatische Vervollständigung abfragt und Vorschläge auf der Karte anzeigt.

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

NameTypBeschreibung
queryLengthIntegerDie Anzahl der Textzeichen.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


setOnChangeAction(action)

Hiermit wird eine Action festgelegt, die ausgeführt wird, wenn sich die Auswahleingabe ändert.

Parameter

NameTypBeschreibung
actionActionDie erforderliche Aktion.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


setPlatformDataSource(platformDataSource)

Hiermit wird eine Datenquelle aus Google Workspace festgelegt. Wird verwendet, um Elemente in einem Menü mit Mehrfachauswahl einzufügen.

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

NameTypBeschreibung
platformDataSourcePlatformDataSourceDie Datenquelle.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


setTitle(title)

Hier legen Sie den Titel fest, der vor dem Eingabefeld angezeigt werden soll.

Parameter

NameTypBeschreibung
titleStringDer Titel des Eingabefelds.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung


setType(type)

Legt den Typ dieser Eingabe fest. Die Standardeinstellung ist CHECKBOX.

Parameter

NameTypBeschreibung
typeSelectionInputTypeDer Auswahltyp.

Rückflug

SelectionInput – dieses Objekt, zur Verkettung