Class Switch

Przełącz

Element interfejsu, który można włączyć lub wyłączyć. Można go używać tylko w widżecie DecoratedText.

Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.

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'),
                    ),
        );

Metody

Metoda	Zwracany typ	Krótki opis
setControlType(controlType)	Switch	Określa typ sterowania przełącznikiem.
setFieldName(fieldName)	Switch	Ustawia klucz, który identyfikuje ten przełącznik w obiekcie zdarzenia generowanym podczas interakcji z interfejsem użytkownika.
setOnChangeAction(action)	Switch	Określa działanie, jakie ma być wykonywane po przełączeniu przełącznika.
setSelected(selected)	Switch	Określa, czy ten przełącznik ma być zaznaczony czy nie.
setValue(value)	Switch	Gdy ten przełącznik jest włączony, ustawia wartość, która jest wysyłana jako dane wejściowe formularza.

Szczegółowa dokumentacja

setControlType(controlType)

Określa typ sterowania przełącznikiem. Domyślna wartość to SWITCH.

Parametry

Nazwa	Typ	Opis
controlType	SwitchControlType	Typ przełącznika.

Powrót

Switch – ten obiekt do łańcucha.

---

setFieldName(fieldName)

Ustawia klucz, który identyfikuje ten przełącznik w obiekcie zdarzenia generowanym podczas interakcji z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagane.

W odróżnieniu od innych pól formularza nazwa tego pola nie musi być unikalna. Wartości formularzy w przypadku przełączników z tą samą nazwą pola są zwracane jako tablica. Tablica zawiera wartości wszystkich włączonych przełączników z tą nazwą pola.

Parametry

Nazwa	Typ	Opis
fieldName	String	Klucz służący do identyfikacji tego przełącznika.

Powrót

Switch – ten obiekt do łańcucha.

---

setOnChangeAction(action)

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

Parametry

Nazwa	Typ	Opis
action	Action	Działanie, które ma być wykonywane po przełączeniu przełącznika.

Powrót

Switch – ten obiekt do łańcucha.

---

setSelected(selected)

Określa, czy ten przełącznik ma być zaznaczony czy nie.

Parametry

Nazwa	Typ	Opis
selected	Boolean	Początkowy stan przełącznika.

Powrót

Switch – ten obiekt do łańcucha.

---

setValue(value)

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

Parametry

Nazwa	Typ	Opis
value	String	Wartość powiązana z nazwą, gdy przełącznik jest włączony. Gdy jest wysyłany do funkcji wywołania zwrotnego formularza, jest zawsze reprezentowany jako ciąg znaków.

Powrót

Switch – ten obiekt do łańcucha.