Élément d'interface utilisateur pouvant ê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.
var 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 commande du contacteur. |
setFieldName(fieldName) | Switch | Définit la clé qui identifie ce commutateur dans l'objet d'événement généré lorsqu'un Interaction avec l'interface utilisateur. |
setOnChangeAction(action) | Switch | Définit l'action à effectuer lorsque le bouton bascule est activé. |
setSelected(selected) | Switch | Détermine si ce contacteur doit démarrer comme sélectionné ou non sélectionné. |
setValue(value) | Switch | Définit la valeur envoyée en tant que saisie du formulaire lorsque ce bouton est activé. |
Documentation détaillée
setControlType(controlType)
Définit le type de commande du contacteur. La valeur par défaut est SWITCH.
Paramètres
| Nom | Type | Description |
|---|---|---|
controlType | SwitchControlType | Type de commande du bouton bascule. |
Renvois
Switch : objet utilisé pour le chaînage.
setFieldName(fieldName)
Définit la clé qui identifie ce commutateur dans l'objet d'événement généré lorsqu'un Interaction avec l'interface utilisateur. Non visible par l'utilisateur. Obligatoire.
Contrairement aux autres champs du formulaire, le nom de ce champ ne doit pas nécessairement être unique. Valeurs d'entrée du formulaire pour les commutateurs utilisant le même nom de champ sont renvoyés sous forme de tableau. Le tableau se compose des éléments suivants : pour tous les commutateurs activés portant ce nom de champ.
Paramètres
| Nom | Type | Description |
|---|---|---|
fieldName | String | Clé permettant d'identifier ce commutateur. |
Renvois
Switch : objet utilisé pour le chaînage.
setOnChangeAction(action)
setSelected(selected)
Détermine si ce contacteur doit démarrer comme sélectionné ou non sélectionné.
Paramètres
| Nom | Type | Description |
|---|---|---|
selected | Boolean | Paramètre d'état du bouton bascule de démarrage. |
Renvois
Switch : objet utilisé pour le chaînage.
setValue(value)
Définit la valeur envoyée en tant que saisie du formulaire lorsque ce bouton est activé.
Paramètres
| Nom | Type | Description |
|---|---|---|
value | String | Valeur associée au nom lorsque l'interrupteur est activé. Lorsque celui-ci est envoyé au il est toujours représenté sous forme de chaîne. |
Renvois
Switch : objet utilisé pour le chaînage.