Class Switch

切換按鈕

支援開啟或關閉的 UI 元素。這種元素只能在 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設定與 UI 互動時產生的事件物件,用來識別這個切換鈕的鍵。
setOnChangeAction(action)Switch設定在切換開關時要執行的動作。
setSelected(selected)Switch設定這個切換鈕應從選取或未選取狀態開始。
setValue(value)Switch設定在切換開關時,傳送做為表單輸入值的值。

內容詳盡的說明文件

setControlType(controlType)

設定開關的控制項類型。預設值為 SWITCH

參數

名稱類型說明
controlTypeSwitchControlType切換控制項類型。

回攻員

Switch:這個物件用於鏈結。


setFieldName(fieldName)

設定與 UI 互動時產生的事件物件,用來識別這個切換鈕的鍵。使用者不會看到這項內容。必填。

與其他表單欄位不同,這個欄位名稱重複。如果切換使用相同欄位名稱,便會以陣列的形式傳回相應的表單輸入值。陣列是由所有具有該欄位名稱的已啟用切換按鈕值所組成。

參數

名稱類型說明
fieldNameString用於識別這個切換鈕的金鑰。

回攻員

Switch:這個物件用於鏈結。


setOnChangeAction(action)

設定在切換開關時要執行的動作。

參數

名稱類型說明
actionAction切換開關時要採取的行動,

回攻員

Switch:這個物件用於鏈結。


setSelected(selected)

設定這個切換鈕應從選取或未選取狀態開始。

參數

名稱類型說明
selectedBoolean起始切換狀態設定。

回攻員

Switch:這個物件用於鏈結。


setValue(value)

設定在切換開關時,傳送做為表單輸入值的值。

參數

名稱類型說明
valueString開關開啟時與該名稱相關聯的值。傳送至表單回呼時,系統一律會以字串表示。

回攻員

Switch:這個物件用於鏈結。