オンとオフの切り替えをサポートする 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")));
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
setControlType(controlType) | Switch | スイッチのコントロール タイプを設定します。 |
setFieldName(fieldName) | Switch | UI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。 |
setOnChangeAction(action) | Switch | スイッチが切り替わったときに行う操作を設定します。 |
setSelected(selected) | Switch | このスイッチを選択状態で開始するか、選択解除して開始するかを設定します。 |
setValue(value) | Switch | このスイッチがオンに切り替えられたときにフォーム入力として送信される値を設定します。 |
詳細なドキュメント
setControlType(controlType)
スイッチのコントロール タイプを設定します。デフォルトは SWITCH
です。
パラメータ
Name | 型 | 説明 |
---|---|---|
controlType | SwitchControlType | スイッチ コントロールのタイプ。 |
リターン
Switch
- チェーン用のこのオブジェクト。
setFieldName(fieldName)
UI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。ユーザーには表示されません。必須。
他のフォーム項目とは異なり、この項目名は一意である必要はありません。同じフィールド名を使用するスイッチのフォーム入力値は、配列として返されます。配列は、そのフィールド名のすべての有効なスイッチの値で構成されます。
パラメータ
Name | 型 | 説明 |
---|---|---|
fieldName | String | このスイッチの識別に使用されるキー。 |
リターン
Switch
- チェーン用のこのオブジェクト。
setOnChangeAction(action)
setSelected(selected)
このスイッチを選択状態で開始するか、選択解除して開始するかを設定します。
パラメータ
Name | 型 | 説明 |
---|---|---|
selected | Boolean | 開始スイッチの状態の設定。 |
リターン
Switch
- チェーン用のこのオブジェクト。
setValue(value)
このスイッチがオンに切り替えられたときにフォーム入力として送信される値を設定します。
パラメータ
Name | 型 | 説明 |
---|---|---|
value | String | スイッチがオンのときに名前に関連付けられた値。これがフォーム コールバックに送信されると、常に文字列として表されます。 |
リターン
Switch
- チェーン用のこのオブジェクト。