Class Switch

Ganti

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

Tersedia untuk Add-on Google Workspace dan aplikasi Google Chat.

const 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 akses.
setFieldName(fieldName)SwitchMenetapkan kunci yang mengidentifikasi tombol ini dalam objek peristiwa yang dihasilkan saat ada interaksi UI.
setOnChangeAction(action)SwitchMenetapkan tindakan yang akan dilakukan saat tombol diaktifkan.
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 akses. Default-nya adalah SWITCH.

Parameter

NamaJenisDeskripsi
controlTypeSwitchControlTypeJenis kontrol tombol akses.

Pulang pergi

Switch — Objek ini, untuk pembuatan rantai.


setFieldName(fieldName)

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

Tidak seperti kolom formulir lainnya, nama kolom ini tidak perlu 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.

Pulang pergi

Switch — Objek ini, untuk pembuatan rantai.


setOnChangeAction(action)

Menetapkan tindakan yang akan dilakukan saat tombol diaktifkan.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus dilakukan saat tombol diaktifkan.

Pulang pergi

Switch — Objek ini, untuk pembuatan rantai.


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 pembuatan rantai.


setValue(value)

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

Parameter

NamaJenisDeskripsi
valueStringNilai yang terkait dengan nama saat tombol diaktifkan. Saat dikirim ke callback form, data ini selalu direpresentasikan sebagai string.

Pulang pergi

Switch — Objek ini, untuk pembuatan rantai.