Class Switch

Przełącz

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

Dostępne w przypadku dodatków do Google Workspace i aplikacji do 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	Ustawia typ sterowania przełącznika.
setFieldName(fieldName)	Switch	Ustawia klucz, który identyfikuje ten przełącznik w obiekcie zdarzenia generowanym podczas interakcji z interfejsem.
setOnChangeAction(action)	Switch	Określa działanie, które ma zostać wykonane po przełączeniu przełącznika.
setSelected(selected)	Switch	Określa, czy ten przełącznik ma być początkowo wybrany czy nie.
setValue(value)	Switch	Ustawia 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 sterowania przełącznika. Domyślna wartość to SWITCH.

Parametry

Nazwa	Typ	Opis
controlType	SwitchControlType	Typ sterowania przełącznikiem.

Powrót

Switch – ten obiekt do łączenia.

---

setFieldName(fieldName)

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

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

Parametry

Nazwa	Typ	Opis
fieldName	String	Klucz używany do identyfikowania tego przełącznika.

Powrót

Switch – ten obiekt do łączenia.

---

setOnChangeAction(action)

Określa działanie, które ma zostać wykonane po przełączeniu przełącznika.

Parametry

Nazwa	Typ	Opis
action	Action	Działanie, które ma zostać wykonane po przełączeniu.

Powrót

Switch – ten obiekt do łączenia.

---

setSelected(selected)

Określa, czy ten przełącznik ma być początkowo wybrany czy nie.

Parametry

Nazwa	Typ	Opis
selected	Boolean	Początkowe ustawienie stanu przełącznika.

Powrót

Switch – ten obiekt do łączenia.

---

setValue(value)

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

Parametry

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

Powrót

Switch – ten obiekt do łączenia.