Class Switch

Wechseln

Ein UI-Element, das aktiviert oder deaktiviert werden kann. Es kann nur in einem DecoratedText-Widget verwendet werden.

Verfügbar für Google Workspace-Add‑ons und Google Chat-Apps.

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'),
                    ),
        );

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
setControlType(controlType)	Switch	Legt den Steuerelementtyp des Schalters fest.
setFieldName(fieldName)	Switch	Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird.
setOnChangeAction(action)	Switch	Legt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgelegt wird.
setSelected(selected)	Switch	Legt fest, ob dieser Schalter anfangs ausgewählt oder nicht ausgewählt sein soll.
setValue(value)	Switch	Legt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.

Detaillierte Dokumentation

setControlType(controlType)

Legt den Steuerelementtyp des Schalters fest. Die Standardeinstellung ist SWITCH.

Parameter

Name	Typ	Beschreibung
controlType	SwitchControlType	Der Schaltersteuerungstyp.

Rückflug

Switch – Dieses Objekt zur Verkettung.

---

setFieldName(fieldName)

Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich.

Im Gegensatz zu anderen Formularfeldern muss dieser Feldname nicht eindeutig sein. Die Formulareingabewerte für Schalter mit demselben Feldnamen werden als Array zurückgegeben. Das Array besteht aus den Werten für alle aktivierten Schalter mit diesem Feldnamen.

Parameter

Name	Typ	Beschreibung
fieldName	String	Der Schlüssel, mit dem dieser Schalter identifiziert wird.

Rückflug

Switch – Dieses Objekt zur Verkettung.

---

setOnChangeAction(action)

Legt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgelegt wird.

Parameter

Name	Typ	Beschreibung
action	Action	Die Aktion, die ausgeführt werden soll, wenn der Schalter umgelegt wird.

Rückflug

Switch – Dieses Objekt zur Verkettung.

---

setSelected(selected)

Legt fest, ob dieser Schalter anfangs ausgewählt oder nicht ausgewählt sein soll.

Parameter

Name	Typ	Beschreibung
selected	Boolean	Die Einstellung für den Startschalterstatus.

Rückflug

Switch – Dieses Objekt zur Verkettung.

---

setValue(value)

Legt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.

Parameter

Name	Typ	Beschreibung
value	String	Der Wert, der dem Namen zugeordnet ist, wenn der Schalter aktiviert ist. Wenn dies an den Formular-Callback gesendet wird, wird es immer als String dargestellt.

Rückflug

Switch – Dieses Objekt zur Verkettung.