Class Switch

切換鈕

可切換開啟或關閉的 UI 元素。此元素只能用於 DecoratedText 小工具。

適用於 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在發生 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：這個物件用於鏈結。