Class Switch

Выключатель

Элемент пользовательского интерфейса, который можно включать и выключать. Его можно использовать только внутри виджета DecoratedText .

Доступно для дополнений Google Workspace и приложений 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'),
                    ),
        );

Методы

Метод Тип возвращаемого значения Краткое описание
set Control Type(controlType) Switch Задает тип управления переключателем.
set Field Name(fieldName) Switch Устанавливает ключ, идентифицирующий этот переключатель в объекте события, генерируемом при взаимодействии с пользовательским интерфейсом.
set On Change Action(action) Switch Задает действие, которое будет выполнено при переключении тумблера.
set Selected(selected) Switch Определяет, должен ли этот переключатель запускаться в выбранном или невыбранном состоянии.
set Value(value) Switch Устанавливает значение, которое отправляется в качестве входных данных формы при включении этого переключателя.

Подробная документация

setControlType(controlType)

Задает тип управления переключателя. По умолчанию — SWITCH .

Параметры

Имя Тип Описание
control Type Switch Control Type Тип управления переключателем.

Возвращаться

Switch — Этот объект используется для создания цепочек вызовов.

setFieldName(fieldName)

Задает ключ, идентифицирующий этот переключатель в объекте события, генерируемом при взаимодействии с пользовательским интерфейсом. Не виден пользователю. Обязательный параметр.

В отличие от других полей формы, имя этого поля не обязательно должно быть уникальным. Значения полей формы для переключателей с одинаковым именем возвращаются в виде массива. Массив содержит значения для всех включенных переключателей с таким именем поля.

Параметры

Имя Тип Описание
field Name String Ключ, используемый для идентификации этого выключателя.

Возвращаться

Switch — Этот объект используется для создания цепочек вызовов.

setOnChangeAction(action)

Задает действие, которое будет выполнено при переключении тумблера.

Параметры

Имя Тип Описание
action Action Действие, которое необходимо выполнить при переключении тумблера.

Возвращаться

Switch — Этот объект используется для создания цепочек вызовов.

setSelected(selected)

Определяет, должен ли этот переключатель запускаться в выбранном или невыбранном состоянии.

Параметры

Имя Тип Описание
selected Boolean Начальное состояние переключателя.

Возвращаться

Switch — Этот объект используется для создания цепочек вызовов.

setValue(value)

Устанавливает значение, которое отправляется в качестве входных данных формы при включении этого переключателя.

Параметры

Имя Тип Описание
value String Значение, связанное с именем, когда переключатель включен. При передаче в функцию обратного вызова формы оно всегда представляется в виде строки.

Возвращаться

Switch — Этот объект используется для создания цепочек вызовов.