Class Switch

Przełącz

Element interfejsu, który można włączać i wyłączać. Tej opcji można używać tylko w widżecie DecoratedText.

Dostępne w przypadku dodatków do Google Workspace i aplikacji 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")));

Metody

MetodaZwracany typKrótki opis
setControlType(controlType)SwitchUstawia typ elementu sterującego przełącznika.
setFieldName(fieldName)SwitchUstawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia, który jest generowany, gdy w obiekcie Interakcja z interfejsem.
setOnChangeAction(action)SwitchOkreśla działanie, jakie ma być wykonywane po przełączeniu przełącznika.
setSelected(selected)SwitchOkreśla, czy ten przełącznik ma się uruchamiać jako wybrany czy niezaznaczony.
setValue(value)SwitchUstawia wartość, która jest wysyłana jako dane wejściowe formularza, gdy ten przełącznik jest włączony.

Szczegółowa dokumentacja

setControlType(controlType)

Ustawia typ elementu sterującego przełącznika. Domyślna wartość to SWITCH.

Parametry

NazwaTypOpis
controlTypeSwitchControlTypeTyp przełącznika.

Powrót

Switch – obiekt do tworzenia łańcuchów.


setFieldName(fieldName)

Ustawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia, który jest generowany, gdy w obiekcie Interakcja z interfejsem. Niewidoczne dla użytkownika. Wymagane.

W przeciwieństwie do innych pól formularza nazwa tego pola nie musi być niepowtarzalna. Wartości wejściowe formularza dla przełączników o tej samej nazwie pola są zwracane jako tablica. Tablica składa się z wartości wszystkich włączonych przełączników z tą nazwą pola.

Parametry

NazwaTypOpis
fieldNameStringKlucz używany do identyfikowania tego przełącznika.

Powrót

Switch – obiekt do tworzenia łańcuchów.


setOnChangeAction(action)

Określa działanie, jakie ma być wykonywane po przełączeniu przełącznika.

Parametry

NazwaTypOpis
actionActionDziałanie, jakie ma zostać wykonane po przełączeniu przełącznika.

Powrót

Switch – obiekt do tworzenia łańcuchów.


setSelected(selected)

Określa, czy ten przełącznik ma się uruchamiać jako wybrany czy niezaznaczony.

Parametry

NazwaTypOpis
selectedBooleanPoczątkowe ustawienie stanu przełącznika.

Powrót

Switch – obiekt do tworzenia łańcuchów.


setValue(value)

Ustawia wartość, która jest wysyłana jako dane wejściowe formularza, gdy ten przełącznik jest włączony.

Parametry

NazwaTypOpis
valueStringWartość powiązana z nazwą, gdy przełącznik jest włączony. Gdy jest on wysyłany do formularza wywołania zwrotnego, jest zawsze reprezentowane przez ciąg znaków.

Powrót

Switch – obiekt do tworzenia łańcuchów.