Élément d'interface utilisateur pouvant être activé ou désactivé. Cet élément ne peut être utilisé que dans un widget DecoratedText.
Disponible avec 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 bouton bascule dans l'objet d'événement généré en cas d'interaction avec l'interface utilisateur. |
setOnChangeAction(action) | Switch | Définit l'action à effectuer lorsque le bouton est activé. |
setSelected(selected) | Switch | Détermine si ce bouton bascule doit démarrer comme sélectionné ou non. |
setValue(value) | Switch | Définit la valeur envoyée en tant qu'entrée de 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 contacteur. |
Renvois
Switch : objet pour le chaînage.
setFieldName(fieldName)
Définit la clé qui identifie ce bouton bascule dans l'objet d'événement généré en cas d'interaction avec l'interface utilisateur. 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 de saisie du formulaire pour les commutateurs 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 avec ce nom de champ.
Paramètres
| Nom | Type | Description |
|---|---|---|
fieldName | String | Touche permettant d'identifier ce bouton bascule. |
Renvois
Switch : objet pour le chaînage.
setOnChangeAction(action)
setSelected(selected)
Détermine si ce bouton bascule doit démarrer comme sélectionné ou non.
Paramètres
| Nom | Type | Description |
|---|---|---|
selected | Boolean | Paramètre d'état de départ du bouton. |
Renvois
Switch : objet pour le chaînage.
setValue(value)
Définit la valeur envoyée en tant qu'entrée de formulaire lorsque ce bouton est activé.
Paramètres
| Nom | Type | Description |
|---|---|---|
value | String | Valeur associée au nom lorsque l'interrupteur est activé. Lorsque cet élément est envoyé au rappel du formulaire, il est toujours représenté par une chaîne. |
Renvois
Switch : objet pour le chaînage.