Class Switch

Przełącz

Element interfejsu, który umożliwia włączanie i wyłączanie. Tego elementu 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

MetodaTyp zwracanej wartościKrótki opis
setControlType(controlType)SwitchSłuży do ustawiania typu elementu sterującego przełącznika.
setFieldName(fieldName)SwitchUstawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia, który jest generowany w przypadku interakcji w interfejsie.
setOnChangeAction(action)SwitchOkreśla działanie, jakie ma być wykonywane po przestawieniu przełącznika.
setSelected(selected)SwitchOkreśla, czy ten przełącznik ma się uruchamiać od wybranej opcji.
setValue(value)SwitchUstawia wartość wysyłaną jako dane wejściowe formularza, gdy ten przełącznik jest włączony.

Szczegółowa dokumentacja

setControlType(controlType)

Służy do ustawiania typu elementu sterującego przełącznika. Domyślna wartość to SWITCH.

Parametry

NazwaTypOpis
controlTypeSwitchControlTypeTyp elementu sterującego przełącznikiem.

Powroty

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


setFieldName(fieldName)

Ustawia klucz identyfikujący ten przełącznik w obiekcie zdarzenia, który jest generowany w przypadku interakcji w interfejsie. Niewidoczne dla użytkownika. To pole jest wymagane.

W przeciwieństwie do innych pól formularza nazwa tego pola nie musi być unikalna. Wartości wejściowe formularza dotyczące przełączników używających tej samej nazwy pola są zwracane jako tablica. Tablica składa się z wartości wszystkich włączonych przełączników o tej nazwie pola.

Parametry

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

Powroty

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


setOnChangeAction(action)

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

Parametry

NazwaTypOpis
actionActionDziałanie, które ma zostać wykonane po przełączeniu przełącznika.

Powroty

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


setSelected(selected)

Określa, czy ten przełącznik ma się uruchamiać od wybranej opcji.

Parametry

NazwaTypOpis
selectedBooleanUstawienie początkowego stanu przełącznika.

Powroty

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


setValue(value)

Ustawia wartość wysyłaną 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 ta wartość jest wysyłana do wywołania zwrotnego formularza, jest zawsze reprezentowana jako ciąg znaków.

Powroty

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