Class SelectionInput

Inputselezione

Un campo di immissione che consente di scegliere tra un insieme di opzioni predefinite.

Supporta la convalida dell'invio del modulo solo per i menu SelectionInputType.DROP_DOWN e SelectionInputType.MULTI_SELECT. Quando Action.setAllWidgetsAreRequired(allWidgetsAreRequired) è impostato su true o questo widget è specificato tramite Action.addRequiredWidget(requiredWidget), l'azione di invio viene bloccata a meno che non venga selezionato un valore.

Disponibile per i componenti aggiuntivi di Google Workspace e le app 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);

Metodi

MetodoTipo restituitoBreve descrizione
addDataSourceConfig(dataSourceConfig)SelectionInputImposta le configurazioni dell'origine dati per il controllo di selezione.
addEventAction(eventAction)WidgetAggiunge l'azione evento che può essere eseguita sul widget.
addItem(text, value, selected)SelectionInputAggiunge un nuovo elemento che può essere selezionato.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputAggiunge un nuovo elemento che può essere selezionato per i menu a selezione multipla.
setExternalDataSource(action)SelectionInputImposta l'origine dati esterna, ad esempio un database relazionale.
setFieldName(fieldName)SelectionInputImposta la chiave che identifica questo input di selezione nell'oggetto evento generato quando si verifica un'interazione con la UI.
setId(id)WidgetImposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputImposta il numero massimo di elementi che un utente può selezionare.
setMultiSelectMinQueryLength(queryLength)SelectionInputImposta il numero di caratteri di testo che un utente inserisce prima che l'app esegua query di completamento automatico e mostri gli elementi suggeriti sulla scheda.
setOnChangeAction(action)SelectionInputImposta un Action da eseguire ogni volta che cambia l'input di selezione.
setPlatformDataSource(platformDataSource)SelectionInputImposta un'origine dati da Google Workspace.
setTitle(title)SelectionInputImposta il titolo da mostrare prima del campo di input.
setType(type)SelectionInputImposta il tipo di questo input.
setVisibility(visibility)WidgetImposta la visibilità del widget.

Documentazione dettagliata

addDataSourceConfig(dataSourceConfig)

Imposta le configurazioni dell'origine dati per il controllo di selezione. Questo campo fornisce un controllo più granulare sull'origine dati. Questo è un campo facoltativo. 

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setDataSourceConfig(
            CardService.newDataSourceConfig().setPlatformDataSource(
                CardService.newPlatformDataSource().setCommonDataSource(
                    CardService.CommonDataSource.USER,
                )
            )
        );

Parametri

NomeTipoDescrizione
dataSourceConfigDataSourceConfigLa configurazione dell'origine dati da applicare all'input di selezione.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

addEventAction(eventAction)

Aggiunge l'azione evento che può essere eseguita sul widget.

Parametri

NomeTipoDescrizione
eventActionEventActionEventAction da aggiungere.

Indietro

Widget: l'oggetto, per il concatenamento.

addItem(text, value, selected)

Aggiunge un nuovo elemento che può essere selezionato.

Parametri

NomeTipoDescrizione
textObjectIl testo da mostrare per questo elemento. Gli argomenti primitivi non stringa vengono convertiti automaticamente in stringhe.
valueObjectIl valore di input del modulo inviato tramite il callback. Gli argomenti primitivi non stringa vengono convertiti automaticamente in stringhe.
selectedBooleanSe l'elemento è selezionato per impostazione predefinita. Se l'input di selezione accetta un solo valore (ad esempio per i pulsanti di opzione o un menu a discesa), imposta questo campo solo per un elemento.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

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

Aggiunge un nuovo elemento che può essere selezionato per i menu a selezione multipla. 

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

Parametri

NomeTipoDescrizione
textObjectIl testo da mostrare per questo elemento. Gli argomenti primitivi non stringa vengono convertiti automaticamente in stringhe.
valueObjectIl valore di input del modulo inviato tramite il callback. Gli argomenti primitivi non stringa vengono convertiti automaticamente in stringhe.
selectedBooleanSe l'elemento è selezionato per impostazione predefinita. Se l'input di selezione accetta un solo valore (ad esempio per i pulsanti di opzione o un menu a discesa), imposta questo campo solo per un elemento.
startIconUriObjectPer i menu a selezione multipla, l'URL dell'icona visualizzata accanto al campo di testo dell'elemento. Supporta i file PNG e JPEG.
bottomTextObjectPer i menu a selezione multipla, una descrizione o un'etichetta di testo visualizzata sotto il campo di testo dell'elemento.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setExternalDataSource(action)

Imposta l'origine dati esterna, ad esempio un database relazionale. 

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

Parametri

NomeTipoDescrizione
actionActionL'origine dati esterna.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setFieldName(fieldName)

Imposta la chiave che identifica questo input di selezione nell'oggetto evento generato quando si verifica un'interazione con la UI. Non visibile all'utente. Obbligatorio, deve essere univoco.

Parametri

NomeTipoDescrizione
fieldNameStringIl nome da assegnare a questo input.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setId(id)

Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. La mutazione dei widget è supportata solo nei componenti aggiuntivi.

Parametri

NomeTipoDescrizione
idStringL'ID del widget, con un limite di 64 caratteri e nel formato `[a-zA-Z0-9-]+`.

Indietro

Widget: questo oggetto, per il concatenamento.

setMultiSelectMaxSelectedItems(maxSelectedItems)

Imposta il numero massimo di elementi che un utente può selezionare. 

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

Parametri

NomeTipoDescrizione
maxSelectedItemsIntegerIl numero massimo di elementi.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setMultiSelectMinQueryLength(queryLength)

Imposta il numero di caratteri di testo che un utente inserisce prima che l'app esegua query di completamento automatico e mostri gli elementi suggeriti sulla scheda. 

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

Parametri

NomeTipoDescrizione
queryLengthIntegerIl numero di caratteri di testo.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setOnChangeAction(action)

Imposta un Action da eseguire ogni volta che cambia l'input di selezione.

Parametri

NomeTipoDescrizione
actionActionL'azione da intraprendere.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setPlatformDataSource(platformDataSource)

Imposta un'origine dati da Google Workspace. Utilizzato per compilare gli elementi in un menu a selezione multipla. 

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );
 Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di Google Workspace.

Parametri

NomeTipoDescrizione
platformDataSourcePlatformDataSourceL'origine dati.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setTitle(title)

Imposta il titolo da mostrare prima del campo di input.

Parametri

NomeTipoDescrizione
titleStringIl titolo del campo di input.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setType(type)

Imposta il tipo di questo input. Il valore predefinito è CHECKBOX.

Parametri

NomeTipoDescrizione
typeSelectionInputTypeIl tipo di selezione.

Indietro

SelectionInput: questo oggetto, per il concatenamento.

setVisibility(visibility)

Imposta la visibilità del widget. Il valore predefinito è "VISIBLE".

Parametri

NomeTipoDescrizione
visibilityVisibilityIl Visibility del widget.

Indietro

Widget: l'oggetto, per il concatenamento.