Class SelectionInput

SelectionInput

Önceden tanımlanmış bir dizi seçenek arasında seçim yapmaya olanak tanıyan bir giriş alanı.

Google Workspace eklentilerinde ve Google Chat uygulamalarında kullanılabilir.

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);

Yöntemler

YöntemDönüş türüKısa açıklama
addItem(text, value, selected)SelectionInputSeçilebilecek yeni bir öğe ekler.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputÇoklu seçim menüleri için seçilebilecek yeni bir öğe ekler.
setExternalDataSource(action)SelectionInputİlişkisel veri tabanı gibi harici veri kaynaklarını belirler.
setFieldName(fieldName)SelectionInputBu seçim girişini tanımlayan anahtarı, oluşturulan etkinlik nesnesinde kullanıcı arayüzü etkileşimi var.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputKullanıcının seçebileceği maksimum öğe sayısını ayarlar.
setMultiSelectMinQueryLength(queryLength)SelectionInputUygulama sorguları otomatik olarak tamamlanmadan önce kullanıcının girdiği metin karakteri sayısını belirler ve önerilen öğeleri kartta görüntüler.
setOnChangeAction(action)SelectionInputSeçim girişi her değiştiğinde uygulanacak bir Action ayarlar.
setPlatformDataSource(platformDataSource)SelectionInputGoogle Workspace'ten bir veri kaynağı ayarlar.
setTitle(title)SelectionInputGiriş alanının önünde gösterilecek başlığı ayarlar.
setType(type)SelectionInputBu girişin türünü ayarlar.

Ayrıntılı belgeler

addItem(text, value, selected)

Seçilebilecek yeni bir öğe ekler.

Parametreler

AdTürAçıklama
textObjectBu öğe için gösterilecek metin. Dize olmayan temel bağımsız değişkenler şuna dönüştürülür: dizeleri otomatik olarak ekler.
valueObjectGeri çağırma ile gönderilen form giriş değeri. Dize olmayan temel bağımsız değişkenler dizelere otomatik olarak dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçili olup olmadığı. Seçim girişi yalnızca bir değer (radyo düğmeleri veya açılır menü gibi) varsa, bu alanı yalnızca bir öğe için ayarlayın.

Return

SelectionInput: Zincirleme için bu nesne.


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

Çoklu seçim menüleri için seçilebilecek yeni bir öğe ekler.

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");

Parametreler

AdTürAçıklama
textObjectBu öğe için gösterilecek metin. Dize olmayan temel bağımsız değişkenler şuna dönüştürülür: dizeleri otomatik olarak ekler.
valueObjectGeri çağırma ile gönderilen form giriş değeri. Dize olmayan temel bağımsız değişkenler dizelere otomatik olarak dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçili olup olmadığı. Seçim girişi yalnızca bir değer (radyo düğmeleri veya açılır menü gibi) varsa, bu alanı yalnızca bir öğe için ayarlayın.
startIconUriObjectÇoklu seçim menülerinde, öğenin yanındaki simgenin URL'si metin alanında gösterilir. PNG ve JPEG dosyalarını destekler.
bottomTextObjectÇoklu seçim menüleri için, menünün altında görüntülenen bir metin açıklaması veya etiket öğesinin metin alanına yapıştırın.

Return

SelectionInput: Zincirleme için bu nesne.


setExternalDataSource(action)

İlişkisel veri tabanı gibi harici veri kaynaklarını belirler.

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"));

Parametreler

AdTürAçıklama
actionActionHarici veri kaynağı.

Return

SelectionInput: Zincirleme için bu nesne.


setFieldName(fieldName)

Bu seçim girişini tanımlayan anahtarı, oluşturulan etkinlik nesnesinde kullanıcı arayüzü etkileşimi var. Kullanıcı tarafından görülemez. Zorunludur ve benzersiz olmalıdır.

Parametreler

AdTürAçıklama
fieldNameStringBu girişe atanacak ad.

Return

SelectionInput: Zincirleme için bu nesne.


setMultiSelectMaxSelectedItems(maxSelectedItems)

Kullanıcının seçebileceği maksimum öğe sayısını ayarlar.

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");

Parametreler

AdTürAçıklama
maxSelectedItemsIntegerMaksimum öğe sayısı.

Return

SelectionInput: Zincirleme için bu nesne.


setMultiSelectMinQueryLength(queryLength)

Uygulama sorguları otomatik olarak tamamlanmadan önce kullanıcının girdiği metin karakteri sayısını belirler ve önerilen öğeleri kartta görüntüler.

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");

Parametreler

AdTürAçıklama
queryLengthIntegerMetin karakterlerinin sayısı.

Return

SelectionInput: Zincirleme için bu nesne.


setOnChangeAction(action)

Seçim girişi her değiştiğinde uygulanacak bir Action ayarlar.

Parametreler

AdTürAçıklama
actionActionYapılacak işlem.

Return

SelectionInput: Zincirleme için bu nesne.


setPlatformDataSource(platformDataSource)

Google Workspace'ten bir veri kaynağı ayarlar. Çoklu seçim menüsündeki öğeleri doldurmak için kullanılır.

const multiSelect = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.MULTI_SELECT)
    .setFieldName("contacts")
    .setTitle("Selected contacts")
    .setPlatformDataSource(
       CardService.newPlatformDataSource()
         .setCommonDataSource(CardService.CommonDataSource.USER));
. Yalnızca Google Chat uygulamalarında kullanılabilir. Google Workspace eklentileriyle kullanılamaz.

Parametreler

AdTürAçıklama
platformDataSourcePlatformDataSourceVeri kaynağı.

Return

SelectionInput: Zincirleme için bu nesne.


setTitle(title)

Giriş alanının önünde gösterilecek başlığı ayarlar.

Parametreler

AdTürAçıklama
titleStringGiriş alanı başlığı.

Return

SelectionInput: Zincirleme için bu nesne.


setType(type)

Bu girişin türünü ayarlar. Varsayılan olarak CHECKBOX değerine ayarlanır.

Parametreler

AdTürAçıklama
typeSelectionInputTypeSeçim türü.

Return

SelectionInput: Zincirleme için bu nesne.