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")));

メソッド

メソッド戻り値の型概要
setControlType(controlType)Switchスイッチのコントロール タイプを設定します。
setFieldName(fieldName)Switchイベントが発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。 UI インタラクション。
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 - チェーン用のオブジェクト。