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)SwitchUI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。
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 - チェーン用のこのオブジェクト。