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

参数

名称类型说明
controlTypeSwitchControlType开关控件类型。

弃踢回攻

Switch - 此对象,用于链接。


setFieldName(fieldName)

在存在界面互动时生成的事件对象中设置用于标识此开关的键。对用户不可见。必需。

与其他表单字段不同,此字段名称不必是唯一的。使用相同字段名称的开关的表单输入值以数组形式返回。该数组包含具有相应字段名称的所有已启用开关的值。

参数

名称类型说明
fieldNameString用于标识此开关的键。

弃踢回攻

Switch - 此对象,用于链接。


setOnChangeAction(action)

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

参数

名称类型说明
actionAction在开关切换时执行的操作。

弃踢回攻

Switch - 此对象,用于链接。


setSelected(selected)

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

参数

名称类型说明
selectedBoolean起始开关状态设置。

弃踢回攻

Switch - 此对象,用于链接。


setValue(value)

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

参数

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

弃踢回攻

Switch - 此对象,用于链接。