このページは Cloud Translation API によって翻訳されました。

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 - チェーン用のこのオブジェクト。