Class Switch

Wechseln

Ein UI-Element, das ein- oder ausgeschaltet werden kann. Dies kann nur innerhalb eines DecoratedText-Widgets 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

MethodeRückgabetypKurzbeschreibung
setControlType(controlType)SwitchLegt den Steuerelementtyp des Schalters fest.
setFieldName(fieldName)SwitchLegt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das generiert wird, wenn ein Interaktion mit der Benutzeroberfläche
setOnChangeAction(action)SwitchLegt die Aktion fest, die ausgeführt werden soll, wenn der Schalter umgeschaltet wird.
setSelected(selected)SwitchLegt fest, ob dieser Schalter als „ausgewählt“ oder „nicht ausgewählt“ gestartet werden soll.
setValue(value)SwitchLegt 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

NameTypBeschreibung
controlTypeSwitchControlTypeDer Typ der Schaltersteuerung.

Rückflug

Switch: Dieses Objekt zur Verkettung.


setFieldName(fieldName)

Legt den Schlüssel fest, der diesen Schalter im Ereignisobjekt identifiziert, das generiert wird, wenn ein Interaktion mit der Benutzeroberfläche Für den Nutzer nicht sichtbar. Erforderlich.

Im Gegensatz zu anderen Formularfeldern muss dieser Feldname nicht eindeutig sein. Eingabewerte für das Formular für Switches mit demselben Feldnamen werden als Array zurückgegeben. Das Array besteht aus den für alle aktivierten Switches mit diesem Feldnamen.

Parameter

NameTypBeschreibung
fieldNameStringDer 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 umgeschaltet wird.

Parameter

NameTypBeschreibung
actionActionDie Aktion, die ausgeführt werden soll, wenn der Schalter umgeschaltet wird.

Rückflug

Switch: Dieses Objekt zur Verkettung.


setSelected(selected)

Legt fest, ob dieser Schalter als „ausgewählt“ oder „nicht ausgewählt“ gestartet werden soll.

Parameter

NameTypBeschreibung
selectedBooleanDie Einstellung für den Status des Startschalters.

Rückflug

Switch: Dieses Objekt zur Verkettung.


setValue(value)

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

Parameter

NameTypBeschreibung
valueStringDer Wert, der dem Namen zugeordnet ist, wenn der Schalter eingeschaltet ist. Wenn diese an den form-Callback sein, wird er immer als String dargestellt.

Rückflug

Switch: Dieses Objekt zur Verkettung.