Diese Seite wurde von der Cloud Translation API übersetzt.

Class Switch

Ein UI-Element, das ein- und ausgeschaltet werden kann. 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`	Hiermit wird der Steuerelementtyp des Schalters festgelegt.
`setFieldName(fieldName)`	`Switch`	Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet.
`setOnChangeAction(action)`	`Switch`	Hier legen Sie fest, welche Aktion ausgeführt werden soll, wenn der Schalter betätigt wird.
`setSelected(selected)`	`Switch`	Hiermit wird festgelegt, ob dieser Schalter zu Beginn ausgewählt oder deaktiviert sein soll.
`setValue(value)`	`Switch`	Legt den Wert fest, der als Formulareingabe gesendet wird, wenn diese Option aktiviert ist.

Detaillierte Dokumentation

`setControlType(controlType)`

Hiermit wird der Steuerelementtyp des Schalters festgelegt. Die Standardeinstellung ist SWITCH.

Parameter

Name	Typ	Beschreibung
`controlType`	`SwitchControlType`	Der Schaltertyp.

Rückflug

Switch – dieses Objekt, zur Verkettung

`setFieldName(fieldName)`

Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet. Nicht für den Nutzer sichtbar. Erforderlich.

Anders als bei 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)`

Hier legen Sie fest, welche Aktion ausgeführt werden soll, wenn der Schalter betätigt wird.

Parameter

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

Rückflug

Switch – dieses Objekt, zur Verkettung

`setSelected(selected)`

Hiermit wird festgelegt, ob dieser Schalter zu Beginn ausgewählt oder deaktiviert sein soll.

Parameter

Name	Typ	Beschreibung
`selected`	`Boolean`	Die Einstellung für den Anfangsstatus des Schalters.

Rückflug

Switch – dieses Objekt, zur Verkettung

`setValue(value)`

Legt den Wert fest, der als Formulareingabe gesendet wird, wenn diese Option aktiviert ist.

Parameter

Name	Typ	Beschreibung
`value`	`String`	Der Wert, der dem Namen zugewiesen ist, wenn der Schalter eingeschaltet ist. Wenn dieser Wert an den Formular-Callback gesendet wird, wird er immer als String dargestellt.

Rückflug

Switch – dieses Objekt, zur Verkettung