Class SelectionInput

SeçimGiriş

Önceden tanımlanmış seçenekler arasından seçim yapmanıza olanak tanıyan bir giriş alanı.

Google Workspace eklentileri ve Google Chat uygulamaları için kullanılabilir.

const 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'),
        );

const 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çilebilen yeni bir öğe ekler.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputBirden fazla seçim yapılabilen menüler için seçilebilecek yeni bir öğe ekler.
setExternalDataSource(action)SelectionInputİlişkisel veritabanı gibi harici veri kaynağını ayarlar.
setFieldName(fieldName)SelectionInputKullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu seçim girişini tanımlayan anahtarı ayarlar.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputKullanıcının seçebileceği maksimum öğe sayısını ayarlar.
setMultiSelectMinQueryLength(queryLength)SelectionInputUygulamanın otomatik tamamlama sorgusu gönderip kartta önerilen öğeleri göstermeden önce kullanıcının gireceği metin karakterlerinin sayısını ayarlar.
setOnChangeAction(action)SelectionInputSeçim girişi her değiştiğinde gerçekleştirilecek 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ı dokümanlar

addItem(text, value, selected)

Seçilebilen yeni bir öğe ekler.

Parametreler

AdTürAçıklama
textObjectBu öğe için gösterilecek metin. Dize olmayan ilkel bağımsız değişkenler otomatik olarak dizeye dönüştürülür.
valueObjectGeri çağırma işlevi aracılığıyla gönderilen form giriş değeri. Dize olmayan ilkel bağımsız değişkenler otomatik olarak dizelere dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçili olup olmadığı. Seçim girişi yalnızca bir değer kabul ediyorsa (ör. radyo düğmeleri veya açılır menü) bu alanı yalnızca bir öğe için ayarlayın.

Return

SelectionInput: Zincirleme için bu nesne.


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

Birden fazla seçim yapılabilen menüler 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 ilkel bağımsız değişkenler otomatik olarak dizeye dönüştürülür.
valueObjectGeri çağırma işlevi aracılığıyla gönderilen form giriş değeri. Dize olmayan ilkel bağımsız değişkenler otomatik olarak dizelere dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçili olup olmadığı. Seçim girişi yalnızca bir değer kabul ediyorsa (ör. radyo düğmeleri veya açılır menü) bu alanı yalnızca bir öğe için ayarlayın.
startIconUriObjectÇoklu seçim menüleri için öğenin metin alanının yanında görüntülenen simgeye ait URL. PNG ve JPEG dosyalarını destekler.
bottomTextObjectÇoklu seçim menüleri için öğenin metin alanının altında görüntülenen metin açıklaması veya etiket.

Return

SelectionInput: Zincirleme için bu nesne.


setExternalDataSource(action)

İlişkisel veritabanı gibi harici veri kaynağını ayarlar.

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)

Kullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu seçim girişini tanımlayan anahtarı ayarlar. Kullanıcı tarafından görülemez. Zorunlu, 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)

Uygulamanın otomatik tamamlama sorgusu gönderip kartta önerilen öğeleri göstermeden önce kullanıcının gireceği metin karakterlerinin sayısını ayarlar.

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 gerçekleştirilecek 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ı için kullanılabilir. Google Workspace eklentileri için 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.