Class Switch

Ganti

Elemen UI yang mendukung untuk diaktifkan atau dinonaktifkan. 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 dalam objek peristiwa yang dibuat 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.

Pulang pergi

Switch — Objek ini, untuk perantaian.


setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi tombol ini dalam objek peristiwa yang dibuat saat ada Interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi.

Tidak seperti kolom formulir lainnya, nama kolom ini tidak harus unik. Nilai-nilai input formulir untuk {i>switch<i} yang menggunakan nama {i>field<i} yang sama, akan dikembalikan sebagai sebuah larik. Array terdiri dari untuk semua tombol yang diaktifkan dengan nama kolom tersebut.

Parameter

NamaJenisDeskripsi
fieldNameStringKunci yang digunakan untuk mengidentifikasi tombol ini.

Pulang pergi

Switch — Objek ini, untuk perantaian.


setOnChangeAction(action)

Menetapkan tindakan yang akan diambil saat tombol dialihkan.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus dilakukan saat tombol dialihkan.

Pulang pergi

Switch — Objek ini, untuk perantaian.


setSelected(selected)

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

Parameter

NamaJenisDeskripsi
selectedBooleanSetelan status tombol awal.

Pulang pergi

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. Ketika pesan ini dikirim ke dari callback, selalu direpresentasikan sebagai string.

Pulang pergi

Switch — Objek ini, untuk perantaian.