Un champ de saisie permettant de choisir entre différentes options prédéfinies
Disponible avec 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 nouvel élément pouvant être sélectionné dans des menus à sélection multiple. |
setExternalDataSource(action) | SelectionInput | Définit une source de données externe, telle qu'une base de données relationnelles. |
setFieldName(fieldName) | SelectionInput | Définit la clé qui identifie cette entrée de sélection dans l'objet d'événement généré en cas d'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 qu'un utilisateur saisit avant que l'application interroge la saisie semi-automatique et affiche des suggestions d'éléments sur la fiche. |
setOnChangeAction(action) | SelectionInput | Définit une 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 qui ne sont pas de type chaîne sont automatiquement convertis en chaînes. |
value | Object | Valeur d'entrée du formulaire envoyée via le rappel. Les arguments primitifs qui ne sont pas de type chaîne sont automatiquement convertis en chaînes. |
selected | Boolean | Indique si l'élément est sélectionné par défaut. Si le champ de sélection n'accepte qu'une seule valeur (pour les cases d'option ou les menus déroulants, par exemple), ne définissez ce champ que pour un seul élément. |
Renvois
SelectionInput
: objet pour le chaînage.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)
Ajoute un nouvel élément pouvant être sélectionné dans des 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 qui ne sont pas de type chaîne sont automatiquement convertis en chaînes. |
value | Object | Valeur d'entrée du formulaire envoyée via le rappel. Les arguments primitifs qui ne sont pas de type chaîne sont automatiquement convertis en chaînes. |
selected | Boolean | Indique si l'élément est sélectionné par défaut. Si le champ de sélection n'accepte qu'une seule valeur (pour les cases d'option ou les menus déroulants, par exemple), ne définissez ce champ que pour un seul élément. |
startIconUri | Object | Pour les menus à sélection multiple, URL de l'icône affichée à côté du champ de texte de l'élément. Les fichiers PNG et JPEG sont acceptés. |
bottomText | Object | Pour les menus multi-sélection, une description textuelle ou un libellé affiché sous le champ de texte de l'élément. |
Renvois
SelectionInput
: objet pour le chaînage.
setExternalDataSource(action)
Définit une source de données externe, telle qu'une base de données relationnelles.
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 | La source de données externe. |
Renvois
SelectionInput
: objet 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é en cas d'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 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 pour le chaînage.
setMultiSelectMinQueryLength(queryLength)
Définit le nombre de caractères de texte qu'un utilisateur saisit avant que l'application interroge la saisie semi-automatique et affiche des suggestions d'éléments 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 pour le chaînage.
setOnChangeAction(action)
Définit une 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 pour le chaînage.
setPlatformDataSource(platformDataSource)
Définit une source de données depuis Google Workspace. Permet de renseigner 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 | La source de données. |
Renvois
SelectionInput
: objet 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 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 pour le chaînage.