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

Class Switch

オンとオフの切り替えをサポートする UI 要素。これは DecoratedText ウィジェット内でのみ使用できます。

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 です。

パラメータ

名前	型	説明
`controlType`	`SwitchControlType`	スイッチコントロールタイプ。

戻る

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

`setFieldName(fieldName)`

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

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

パラメータ

名前	型	説明
`fieldName`	`String`	このスイッチの識別に使用されるキー。

戻る

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

`setOnChangeAction(action)`

スイッチが切り替えられたときに実行するアクションを設定します。

パラメータ

名前	型	説明
`action`	`Action`	スイッチが切り替えられたときに実行されるアクション。

戻る

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

`setSelected(selected)`

このスイッチを選択済みにするかどうかを選択します。

パラメータ

名前	型	説明
`selected`	`Boolean`	開始時のスイッチの状態の設定。

戻る

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

`setValue(value)`

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

パラメータ

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

戻る

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