Class Switch

Bouton bascule

Élément d'interface utilisateur qui peut être activé ou désactivé. Il ne peut être utilisé que dans un widget DecoratedText.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

const switchDecoratedText =
    CardService.newDecoratedText()
        .setTopLabel('Switch decorated text widget label')
        .setText('This is a decorated text widget with a switch on the right')
        .setWrapText(true)
        .setSwitchControl(
            CardService.newSwitch()
                .setFieldName('form_input_switch_key')
                .setValue('form_input_switch_value')
                .setOnChangeAction(
                    CardService.newAction().setFunctionName(
                        'handleSwitchChange'),
                    ),
        );

Méthodes

Méthode	Type renvoyé	Brève description
setControlType(controlType)	Switch	Définit le type de sélecteur du bouton bascule.
setFieldName(fieldName)	Switch	Définit la clé qui identifie ce commutateur dans l'objet d'événement généré en cas d'interaction avec l'UI.
setOnChangeAction(action)	Switch	Définit l'action à effectuer lorsque le bouton bascule est activé.
setSelected(selected)	Switch	Indique si ce bouton bascule doit être sélectionné ou non au démarrage.
setValue(value)	Switch	Définit la valeur qui est envoyée comme entrée de formulaire lorsque ce bouton est activé.

Documentation détaillée

setControlType(controlType)

Définit le type de sélecteur du bouton bascule. La valeur par défaut est SWITCH.

Paramètres

Nom	Type	Description
controlType	SwitchControlType	Type de sélecteur.

Renvois

Switch : cet objet, pour le chaînage.

---

setFieldName(fieldName)

Définit la clé qui identifie ce commutateur dans l'objet d'événement généré en cas d'interaction avec l'UI. Non visible par l'utilisateur. Obligatoire.

Contrairement aux autres champs de formulaire, ce nom de champ n'a pas besoin d'être unique. Les valeurs d'entrée du formulaire pour les boutons bascule utilisant le même nom de champ sont renvoyées sous forme de tableau. Le tableau se compose des valeurs de tous les commutateurs activés portant ce nom de champ.

Paramètres

Nom	Type	Description
fieldName	String	Clé utilisée pour identifier ce commutateur.

Renvois

Switch : cet objet, pour le chaînage.

---

setOnChangeAction(action)

Définit l'action à effectuer lorsque le bouton bascule est activé.

Paramètres

Nom	Type	Description
action	Action	Action à effectuer lorsque le bouton bascule est activé.

Renvois

Switch : cet objet, pour le chaînage.

---

setSelected(selected)

Indique si ce bouton bascule doit être sélectionné ou non au démarrage.

Paramètres

Nom	Type	Description
selected	Boolean	Paramètre de l'état initial du bouton bascule.

Renvois

Switch : cet objet, pour le chaînage.

---

setValue(value)

Définit la valeur qui est envoyée comme entrée de formulaire lorsque ce bouton est activé.

Paramètres

Nom	Type	Description
value	String	Valeur associée au nom lorsque le bouton est activé. Lorsqu'il est envoyé au rappel de formulaire, il est toujours représenté sous forme de chaîne.

Renvois

Switch : cet objet, pour le chaînage.