Class Switch

Ganti

Elemen UI yang mendukung pengaktifan atau penonaktifan. Ini hanya dapat digunakan dalam widget DecoratedText.

Tersedia untuk Add-on Google Workspace dan aplikasi 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")));

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setControlType(controlType)SwitchMenetapkan jenis kontrol tombol.
setFieldName(fieldName)SwitchMenetapkan kunci yang mengidentifikasi tombol ini pada objek peristiwa yang dihasilkan saat ada interaksi UI.
setOnChangeAction(action)SwitchMenetapkan tindakan yang akan diambil saat tombol dialihkan.
setSelected(selected)SwitchMenetapkan apakah tombol ini harus dimulai sebagai dipilih atau tidak dipilih.
setValue(value)SwitchMenetapkan nilai yang dikirim sebagai input formulir saat tombol ini diaktifkan.

Dokumentasi mendetail

setControlType(controlType)

Menetapkan jenis kontrol tombol. Default-nya adalah SWITCH.

Parameter

NamaJenisDeskripsi
controlTypeSwitchControlTypeJenis kontrol tombol akses.

Return

Switch — Objek ini, untuk perantaian.


setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi tombol ini pada objek peristiwa yang dihasilkan saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib.

Tidak seperti kolom formulir lainnya, nama kolom ini tidak harus unik. Nilai input formulir untuk tombol yang menggunakan nama kolom yang sama ditampilkan sebagai array. Array terdiri dari nilai untuk semua tombol yang diaktifkan dengan nama kolom tersebut.

Parameter

NamaJenisDeskripsi
fieldNameStringKunci yang digunakan untuk mengidentifikasi tombol ini.

Return

Switch — Objek ini, untuk perantaian.


setOnChangeAction(action)

Menetapkan tindakan yang akan diambil saat tombol dialihkan.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus diambil saat tombol dialihkan.

Return

Switch — Objek ini, untuk perantaian.


setSelected(selected)

Menetapkan apakah tombol ini harus dimulai sebagai dipilih atau tidak dipilih.

Parameter

NamaJenisDeskripsi
selectedBooleanSetelan status tombol awal.

Return

Switch — Objek ini, untuk perantaian.


setValue(value)

Menetapkan nilai yang dikirim sebagai input formulir saat tombol ini diaktifkan.

Parameter

NamaJenisDeskripsi
valueStringNilai yang terkait dengan nama saat tombol aktif. Jika dikirim ke callback formulir, parameter ini selalu direpresentasikan sebagai string.

Return

Switch — Objek ini, untuk perantaian.