Cette page a été traduite par l'API Cloud Translation.

Class SelectionInput

Champ de saisie qui permet de choisir parmi un ensemble d'options prédéfinies.

Disponible pour les modules complémentaires Google Workspace et les applications 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);

Méthodes

Méthode	Type renvoyé	Brève description
`addItem(text, value, selected)`	`SelectionInput`	Ajoute un nouvel élément pouvant être sélectionné.
`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`	`SelectionInput`	Ajoute un élément pouvant être sélectionné pour les menus à sélection multiple.
`setExternalDataSource(action)`	`SelectionInput`	Définit une source de données externe, telle qu'une base de données relationnelle.
`setFieldName(fieldName)`	`SelectionInput`	Définit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré lors de la il y a une interaction avec l'interface utilisateur.
`setMultiSelectMaxSelectedItems(maxSelectedItems)`	`SelectionInput`	Définit le nombre maximal d'éléments qu'un utilisateur peut sélectionner.
`setMultiSelectMinQueryLength(queryLength)`	`SelectionInput`	Définit le nombre de caractères de texte saisis par l'utilisateur avant que l'application n'interroge la saisie semi-automatique et affiche les éléments suggérés sur la fiche.
`setOnChangeAction(action)`	`SelectionInput`	Définit un `Action` à exécuter chaque fois que l'entrée de sélection change.
`setPlatformDataSource(platformDataSource)`	`SelectionInput`	Définit une source de données depuis Google Workspace.
`setTitle(title)`	`SelectionInput`	Définit le titre à afficher avant le champ de saisie.
`setType(type)`	`SelectionInput`	Définit le type de cette entrée.

Documentation détaillée

`addItem(text, value, selected)`

Ajoute un nouvel élément pouvant être sélectionné.

Paramètres

Nom	Type	Description
`text`	`Object`	Texte à afficher pour cet élément. Les arguments primitifs non de type chaîne sont convertis en automatiquement.
`value`	`Object`	Valeur d'entrée du formulaire envoyée via le rappel. Arguments primitifs non sous forme de chaîne sont automatiquement converties en chaînes.
`selected`	`Boolean`	Indique si l'élément est sélectionné par défaut. Si l'entrée de sélection n'accepte Une seule valeur (pour des cases d'option ou un menu déroulant, par exemple), définissez ce champ pour un seul élément.

Renvois

SelectionInput : objet utilisé pour le chaînage.

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

Ajoute un élément pouvant être sélectionné pour les menus à sélection multiple.

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

Paramètres

Nom	Type	Description
`text`	`Object`	Texte à afficher pour cet élément. Les arguments primitifs non de type chaîne sont convertis en automatiquement.
`value`	`Object`	Valeur d'entrée du formulaire envoyée via le rappel. Arguments primitifs non sous forme de chaîne sont automatiquement converties en chaînes.
`selected`	`Boolean`	Indique si l'élément est sélectionné par défaut. Si l'entrée de sélection n'accepte Une seule valeur (pour des cases d'option ou un menu déroulant, par exemple), définissez ce champ pour un seul élément.
`startIconUri`	`Object`	Pour les menus à sélection multiple, l'URL de l'icône affichée à côté de l'icône . Compatible avec les fichiers PNG et JPEG.
`bottomText`	`Object`	Pour les menus à sélection multiple, une description textuelle ou un libellé qui s'affiche sous la dans le champ de texte de l'élément.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setExternalDataSource(action)`

Définit une source de données externe, telle qu'une base de données relationnelle.

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

Paramètres

Nom	Type	Description
`action`	`Action`	Source de données externe.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setFieldName(fieldName)`

Définit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré lors de la il y a une interaction avec l'interface utilisateur. Non visible par l'utilisateur. Obligatoire, doit être unique.

Paramètres

Nom	Type	Description
`fieldName`	`String`	Nom à attribuer à cette entrée.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setMultiSelectMaxSelectedItems(maxSelectedItems)`

Définit le nombre maximal d'éléments qu'un utilisateur peut sélectionner.

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

Paramètres

Nom	Type	Description
`maxSelectedItems`	`Integer`	Nombre maximal d'éléments.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setMultiSelectMinQueryLength(queryLength)`

Définit le nombre de caractères de texte saisis par l'utilisateur avant que l'application n'interroge la saisie semi-automatique et affiche les éléments suggérés sur la fiche.

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

Paramètres

Nom	Type	Description
`queryLength`	`Integer`	Nombre de caractères de texte.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setOnChangeAction(action)`

Définit un Action à exécuter chaque fois que l'entrée de sélection change.

Paramètres

Nom	Type	Description
`action`	`Action`	Action à effectuer.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setPlatformDataSource(platformDataSource)`

Définit une source de données depuis Google Workspace. Permet d'afficher les éléments d'un menu multi-sélection.

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

Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.

Paramètres

Nom	Type	Description
`platformDataSource`	`PlatformDataSource`	Source de données.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setTitle(title)`

Définit le titre à afficher avant le champ de saisie.

Paramètres

Nom	Type	Description
`title`	`String`	Titre du champ de saisie.

Renvois

SelectionInput : objet utilisé pour le chaînage.

`setType(type)`

Définit le type de cette entrée. La valeur par défaut est CHECKBOX.

Paramètres

Nom	Type	Description
`type`	`SelectionInputType`	Type de sélection.

Renvois

SelectionInput : objet utilisé pour le chaînage.