Class SelectionInput

SelectionInput

Kolom input yang memungkinkan Anda memilih di antara serangkaian opsi yang telah ditentukan.

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

var checkboxGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.CHECK_BOX)
    .setTitle("A group of checkboxes. Multiple selections are allowed.")
    .setFieldName("checkbox_field")
    .addItem("checkbox one title", "checkbox_one_value", false)
    .addItem("checkbox two title", "checkbox_two_value", true)
    .addItem("checkbox three title", "checkbox_three_value", true)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleCheckboxChange"));

var radioGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.RADIO_BUTTON)
    .setTitle("A group of radio buttons. Only a single selection is allowed.")
    .setFieldName("checkbox_field")
    .addItem("radio button one title", "radio_one_value", true)
    .addItem("radio button two title", "radio_two_value", false)
    .addItem("radio button three title", "radio_three_value", false);

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description")
    .setMultiSelectMaxSelectedItems(3)
    .setMultiSelectMinQueryLength(1);

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addItem(text, value, selected)SelectionInputMenambahkan item baru yang dapat dipilih.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputMenambahkan item baru yang dapat dipilih untuk menu pilihan yang multi-pilihan.
setExternalDataSource(action)SelectionInputMenetapkan sumber data eksternal, seperti basis data relasional.
setFieldName(fieldName)SelectionInputMenetapkan kunci yang mengidentifikasi input pilihan ini dalam objek peristiwa yang dibuat saat ada interaksi UI.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputMenetapkan jumlah item maksimum yang dapat dipilih pengguna.
setMultiSelectMinQueryLength(queryLength)SelectionInputMenetapkan jumlah karakter teks yang dimasukkan pengguna sebelum kueri aplikasi pelengkapan otomatis dan menampilkan item yang disarankan pada kartu.
setOnChangeAction(action)SelectionInputMenetapkan Action untuk dilakukan setiap kali input pilihan berubah.
setPlatformDataSource(platformDataSource)SelectionInputMenetapkan sumber data dari Google Workspace.
setTitle(title)SelectionInputMenetapkan judul untuk ditampilkan sebelum kolom input.
setType(type)SelectionInputMenetapkan jenis input ini.

Dokumentasi mendetail

addItem(text, value, selected)

Menambahkan item baru yang dapat dipilih.

Parameter

NamaJenisDeskripsi
textObjectTeks yang akan ditampilkan untuk item ini. Argumen primitif non-string dikonversi menjadi {i>string<i} secara otomatis.
valueObjectNilai input formulir yang dikirim melalui callback. Argumen primitif non-string dikonversi menjadi {i>string<i} secara otomatis.
selectedBooleanApakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), hanya setel kolom ini untuk satu item.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


addMultiSelectItem(text, value, selected, startIconUri, bottomText)

Menambahkan item baru yang dapat dipilih untuk menu pilihan yang multi-pilihan.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Parameter

NamaJenisDeskripsi
textObjectTeks yang akan ditampilkan untuk item ini. Argumen primitif non-string dikonversi menjadi {i>string<i} secara otomatis.
valueObjectNilai input formulir yang dikirim melalui callback. Argumen primitif non-string dikonversi menjadi {i>string<i} secara otomatis.
selectedBooleanApakah item dipilih secara default. Jika input pilihan hanya menerima satu nilai (seperti untuk tombol pilihan atau menu dropdown), hanya setel kolom ini untuk satu item.
startIconUriObjectUntuk menu multi-pilihan, URL untuk ikon yang ditampilkan di samping kolom teks. Mendukung file PNG dan JPEG.
bottomTextObjectUntuk menu pilihan banyak, deskripsi teks atau label yang ditampilkan di bawah isian teks item.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setExternalDataSource(action)

Menetapkan sumber data eksternal, seperti basis data relasional.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .setMultiSelectMaxSelectedItems(5)
    .setMultiSelectMinQueryLength(2)
    .setExternalDataSource(CardService.newAction().setFunctionName("getContacts"));

Parameter

NamaJenisDeskripsi
actionActionSumber data eksternal.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi input pilihan ini dalam objek peristiwa yang dibuat saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi, harus unik.

Parameter

NamaJenisDeskripsi
fieldNameStringNama yang akan ditetapkan ke input ini.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setMultiSelectMaxSelectedItems(maxSelectedItems)

Menetapkan jumlah item maksimum yang dapat dipilih pengguna.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMaxSelectedItems(3)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Parameter

NamaJenisDeskripsi
maxSelectedItemsIntegerJumlah item maksimum.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setMultiSelectMinQueryLength(queryLength)

Menetapkan jumlah karakter teks yang dimasukkan pengguna sebelum kueri aplikasi pelengkapan otomatis dan menampilkan item yang disarankan pada kartu.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("multiselect")
    .setTitle("A multi select input example.")
    .setMultiSelectMinQueryLength(1)
    .addMultiSelectItem("Contact 1", "contact-1", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact one description")
    .addMultiSelectItem("Contact 2", "contact-2", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact two description")
    .addMultiSelectItem("Contact 3", "contact-3", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact three description")
    .addMultiSelectItem("Contact 4", "contact-4", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact four description")
    .addMultiSelectItem("Contact 5", "contact-5", false,
       "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
       "Contact five description");

Parameter

NamaJenisDeskripsi
queryLengthIntegerJumlah karakter teks.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setOnChangeAction(action)

Menetapkan Action untuk dilakukan setiap kali input pilihan berubah.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus diambil.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setPlatformDataSource(platformDataSource)

Menetapkan sumber data dari Google Workspace. Digunakan untuk mengisi item dalam menu multi-pilihan.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .setPlatformDataSource(
       CardService.newPlatformDataSource()
         .setCommonDataSource(CardService.CommonDataSource.USER));
Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk Add-on Google Workspace.

Parameter

NamaJenisDeskripsi
platformDataSourcePlatformDataSourceSumber data.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setTitle(title)

Menetapkan judul untuk ditampilkan sebelum kolom input.

Parameter

NamaJenisDeskripsi
titleStringJudul kolom input.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.


setType(type)

Menetapkan jenis input ini. Default-nya adalah CHECKBOX.

Parameter

NamaJenisDeskripsi
typeSelectionInputTypeJenis pemilihan.

Pulang pergi

SelectionInput — Objek ini, untuk perantaian.