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	設定鍵，以在發生問題時所產生的事件物件中，識別此開關 使用者介面互動。
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：這個物件用於鏈結。