Class Switch

スイッチ

オンとオフの切り替えをサポートする 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)SwitchUI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。
setOnChangeAction(action)Switchスイッチが切り替わったときに行う操作を設定します。
setSelected(selected)Switchこのスイッチを選択状態で開始するか、選択解除して開始するかを設定します。
setValue(value)Switchこのスイッチがオンに切り替えられたときにフォーム入力として送信される値を設定します。

詳細なドキュメント

setControlType(controlType)

スイッチのコントロール タイプを設定します。デフォルトは SWITCH です。

パラメータ

Name説明
controlTypeSwitchControlTypeスイッチ コントロールのタイプ。

リターン

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


setFieldName(fieldName)

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

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

パラメータ

Name説明
fieldNameStringこのスイッチの識別に使用されるキー。

リターン

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


setOnChangeAction(action)

スイッチが切り替わったときに行う操作を設定します。

パラメータ

Name説明
actionActionスイッチが切り替わったときに実行されるアクション。

リターン

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


setSelected(selected)

このスイッチを選択状態で開始するか、選択解除して開始するかを設定します。

パラメータ

Name説明
selectedBoolean開始スイッチの状態の設定。

リターン

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


setValue(value)

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

パラメータ

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

リターン

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