Элемент пользовательского интерфейса, который поддерживает включение и выключение. Это можно использовать только в виджете DecoratedText .
Доступно для дополнений Google Workspace и приложений 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")));Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setControlType(controlType) | Switch | Устанавливает тип управления переключателем. |
setFieldName(fieldName) | Switch | Устанавливает ключ, идентифицирующий этот переключатель, в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setOnChangeAction(action) | Switch | Устанавливает действие, которое необходимо выполнить при переключении переключателя. |
setSelected(selected) | Switch | Устанавливает, должен ли этот переключатель запускаться как выбранный или невыбранный. |
setValue(value) | Switch | Устанавливает значение, которое отправляется в качестве входных данных формы, когда этот переключатель включен. |
Подробная документация
setControlType(controlType)
Устанавливает тип управления переключателем. По умолчанию SWITCH .
Параметры
| Имя | Тип | Описание |
|---|---|---|
controlType | SwitchControlType | Тип управления переключателем. |
Возвращаться
Switch — этот объект для цепочки.
setFieldName(fieldName)
Устанавливает ключ, идентифицирующий этот переключатель, в объекте события, который создается при взаимодействии пользовательского интерфейса. Не виден пользователю. Необходимый.
В отличие от других полей формы, это имя поля не обязательно должно быть уникальным. Входные значения формы для переключателей, использующих одно и то же имя поля, возвращаются в виде массива. Массив состоит из значений для всех включенных переключателей с этим именем поля.
Параметры
| Имя | Тип | Описание |
|---|---|---|
fieldName | String | Ключ, который используется для идентификации этого переключателя. |
Возвращаться
Switch — этот объект для цепочки.
setOnChangeAction(action)
setSelected(selected)
Устанавливает, должен ли этот переключатель запускаться как выбранный или невыбранный.
Параметры
| Имя | Тип | Описание |
|---|---|---|
selected | Boolean | Настройка состояния пускового переключателя. |
Возвращаться
Switch — этот объект для цепочки.
setValue(value)
Устанавливает значение, которое отправляется в качестве входных данных формы, когда этот переключатель включен.
Параметры
| Имя | Тип | Описание |
|---|---|---|
value | String | Значение, связанное с именем, когда переключатель включен. Когда это отправляется в обратный вызов формы, оно всегда представляется в виде строки. |
Возвращаться
Switch — этот объект для цепочки.