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 です。

パラメータ

名前	タイプ	説明
controlType	SwitchControlType	スイッチのコントロール タイプ。

戻る

Switch - チェーン用のこのオブジェクト。

---

setFieldName(fieldName)

UI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。ユーザーには表示されません。必須。

他のフォーム フィールドとは異なり、このフィールド名を一意にする必要はありません。同じフィールド名を使用するスイッチのフォーム入力値は、配列として返されます。配列は、そのフィールド名を持つ有効なすべてのスイッチの値で構成されます。

パラメータ

名前	タイプ	説明
fieldName	String	このスイッチの識別に使用されるキー。

戻る

Switch - チェーン用のこのオブジェクト。

---

setOnChangeAction(action)

スイッチが切り替えられたときに実行するアクションを設定します。

パラメータ

名前	タイプ	説明
action	Action	スイッチが切り替えられたときに実行するアクション。

戻る

Switch - チェーン用のこのオブジェクト。

---

setSelected(selected)

このスイッチをオンにした状態で開始するか、オフにした状態で開始するかを設定します。

パラメータ

名前	タイプ	説明
selected	Boolean	スイッチの開始状態の設定。

戻る

Switch - チェーン用のこのオブジェクト。

---

setValue(value)

このスイッチがオンになったときにフォーム入力として送信される値を設定します。

パラメータ

名前	タイプ	説明
value	String	スイッチがオンのときに名前に関連付けられる値。これが フォーム コールバックに送信されると、常に文字列として表されます。

戻る

Switch - チェーン用のこのオブジェクト。