Class Switch

开关

支持开启或关闭的界面元素。此元素只能在 DecoratedText widget 中使用。

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

方法

方法	返回类型	简介
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)

设置在切换开关时要执行的操作。

参数

名称	类型	说明
action	Action	切换开关时要执行的操作。

返回

Switch - 此对象，用于链式调用。

---

setSelected(selected)

设置相应开关应以选中状态还是未选中状态启动。

参数

名称	类型	说明
selected	Boolean	初始开关状态设置。

返回

Switch - 此对象，用于链式调用。

---

setValue(value)

设置在切换到开启状态时作为表单输入发送的值。

参数

名称	类型	说明
value	String	开关处于开启状态时与名称关联的值。当此值发送到表单回调时，始终表示为字符串。

返回

Switch - 此对象，用于链式调用。