Ein UI-Element, das das Ein- und Ausschalten unterstützt. Dies kann nur in einem DecoratedText
-Widget verwendet werden.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
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")));
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. Dieses wird bei einer UI-Interaktion generiert. |
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 als aktiviert oder nicht ausgewählt beginnen 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
.
Parameters
Name | Typ | Beschreibung |
---|---|---|
controlType | SwitchControlType | Art der Schaltersteuerung. |
Return
Switch
: Dieses Objekt zur Verkettung.
setFieldName(fieldName)
Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert. Dieses wird bei einer UI-Interaktion generiert. 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.
Parameters
Name | Typ | Beschreibung |
---|---|---|
fieldName | String | Der Schlüssel, mit dem dieser Schalter identifiziert wird. |
Return
Switch
: Dieses Objekt zur Verkettung.
setOnChangeAction(action)
setSelected(selected)
Legt fest, ob dieser Schalter als aktiviert oder nicht ausgewählt beginnen soll.
Parameters
Name | Typ | Beschreibung |
---|---|---|
selected | Boolean | Die Ausgangseinstellung für den Schalterstatus. |
Return
Switch
: Dieses Objekt zur Verkettung.
setValue(value)
Legt den Wert fest, der als Formulareingabe gesendet wird, wenn dieser Schalter aktiviert ist.
Parameters
Name | Typ | Beschreibung |
---|---|---|
value | String | Der Wert, der dem Namen zugeordnet ist, wenn der Schalter auf „Ein“ gestellt ist. Wenn er an den Formular-Callback gesendet wird, wird er immer als String dargestellt. |
Return
Switch
: Dieses Objekt zur Verkettung.