Class Switch

开关

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

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

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

参数

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

返回

Switch - 此对象，用于链接。

---

setSelected(selected)

设置此开关在启动时是处于已选中还是未选中状态。

参数

名称	类型	说明
selected	Boolean	启动开关状态设置。

返回

Switch - 此对象，用于链接。

---

setValue(value)

设置此开关开启时作为表单输入发送的值。

参数

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

返回

Switch - 此对象，用于链接。