Class SelectionInput

SelectionInput

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

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

Metodi

MetodoTipo restituitoBreve descrizione
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 un'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.
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 esegui la query sul completamento automatico e mostra gli elementi suggeriti nella 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 visualizzare prima del campo di immissione.
setType(type)SelectionInputImposta il tipo di questo input.

Documentazione dettagliata

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 di stringa vengono convertiti automaticamente in stringhe.
valueObjectIl valore di input del modulo che viene inviato tramite il callback. Gli argomenti primitivi non di stringa vengono convertiti automaticamente in stringhe.
selectedBooleanIndica se l'elemento è selezionato per impostazione predefinita. Se l'input di selezione accetta solo un valore (ad esempio per i pulsanti di opzione o un menu a discesa), imposta questo campo solo per un elemento.

Ritorni

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 di stringa vengono convertiti automaticamente in stringhe.
valueObjectIl valore di input del modulo che viene inviato tramite il callback. Gli argomenti primitivi non di stringa vengono convertiti automaticamente in stringhe.
selectedBooleanIndica se l'elemento è selezionato per impostazione predefinita. Se l'input di selezione accetta solo un 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, è presente una descrizione o un'etichetta di testo visualizzata sotto il campo di testo dell'elemento.

Ritorni

SelectionInput: questo oggetto per il concatenamento.


setExternalDataSource(action)

Imposta un'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.

Ritorni

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.

Ritorni

SelectionInput: 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.

Ritorni

SelectionInput: questo oggetto per il concatenamento.


setMultiSelectMinQueryLength(queryLength)

Imposta il numero di caratteri di testo che un utente inserisce prima che l'app esegui la query sul completamento automatico e mostra gli elementi suggeriti nella 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.

Ritorni

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 eseguire.

Ritorni

SelectionInput: questo oggetto per il concatenamento.


setPlatformDataSource(platformDataSource)

Imposta un'origine dati da Google Workspace. Utilizzato per completare 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.

Ritorni

SelectionInput: questo oggetto per il concatenamento.


setTitle(title)

Imposta il titolo da visualizzare prima del campo di immissione.

Parametri

NomeTipoDescrizione
titleStringIl titolo del campo di immissione.

Ritorni

SelectionInput: questo oggetto per il concatenamento.


setType(type)

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

Parametri

NomeTipoDescrizione
typeSelectionInputTypeIl tipo di selezione.

Ritorni

SelectionInput: questo oggetto per il concatenamento.