Class SelectionInput

SeçimGiriş

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

Yalnızca SelectionInputType.DROP_DOWN ve SelectionInputType.MULTI_SELECT menüleri için form gönderimi doğrulaması desteklenir. Action.setAllWidgetsAreRequired(allWidgetsAreRequired), true olarak ayarlandığında veya bu widget Action.addRequiredWidget(requiredWidget) aracılığıyla belirtildiğinde bir değer seçilmediği sürece gönderme işlemi engellenir.

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
addDataSourceConfig(dataSourceConfig)SelectionInputSeçim kontrolü için veri kaynağı yapılandırmalarını ayarlar.
addEventAction(eventAction)WidgetWidget'ta gerçekleştirilebilecek etkinlik işlemini ekler.
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 veritabanı gibi harici veri kaynağını ayarlar.
setFieldName(fieldName)SelectionInputBir kullanıcı arayüzü etkileşimi olduğunda oluşturulan etkinlik nesnesinde bu seçim girişini tanımlayan anahtarı ayarlar.
setId(id)WidgetDeğiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputKullanıcının seçebileceği maksimum öğe sayısını ayarlar.
setMultiSelectMinQueryLength(queryLength)SelectionInputUygulamanın otomatik tamamlamayı sorgulamadan ve kartta önerilen öğeleri göstermeden önce kullanıcının girdiği metin karakteri 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)SelectionInputBaşlığı, giriş alanının önünde gösterilecek şekilde ayarlar.
setType(type)SelectionInputBu girişin türünü ayarlar.
setVisibility(visibility)WidgetWidget'ın görünürlüğünü ayarlar.

Ayrıntılı belgeler

addDataSourceConfig(dataSourceConfig)

Seçim kontrolü için veri kaynağı yapılandırmalarını ayarlar. Bu alan, veri kaynağı üzerinde daha ayrıntılı kontrol sağlar. Bu alan isteğe bağlıdır.

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setDataSourceConfig(
            CardService.newDataSourceConfig().setPlatformDataSource(
                CardService.newPlatformDataSource().setCommonDataSource(
                    CardService.CommonDataSource.USER,
                )
            )
        );

Parametreler

AdTürAçıklama
dataSourceConfigDataSourceConfigSeçim girişine uygulanacak veri kaynağı yapılandırması.

Return

SelectionInput: Zincirleme için kullanılan bu nesne.


addEventAction(eventAction)

Widget'ta gerçekleştirilebilecek etkinlik işlemini ekler.

Parametreler

AdTürAçıklama
eventActionEventActionEklenecek EventAction.

Return

Widget: Zincirleme için kullanılan Nesne.


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 otomatik olarak dizelere dönüştürülür.
valueObjectGeri çağırma işlevi aracılığıyla gönderilen form giriş değeri. Dize olmayan temel bağımsız değişkenler otomatik olarak dizelere dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçilip seçilmediği. 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 kullanılan 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 otomatik olarak dizelere dönüştürülür.
valueObjectGeri çağırma işlevi aracılığıyla gönderilen form giriş değeri. Dize olmayan temel bağımsız değişkenler otomatik olarak dizelere dönüştürülür.
selectedBooleanÖğenin varsayılan olarak seçilip seçilmediği. 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ülerinde, öğenin metin alanının yanında gösterilen simgenin URL'si. PNG ve JPEG dosyalarını destekler.
bottomTextObjectÇoklu seçim menülerinde, öğenin metin alanının altında gösterilen bir metin açıklaması veya etiket.

Return

SelectionInput: Zincirleme için kullanılan 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 kullanılan bu nesne.


setFieldName(fieldName)

Bir 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ülmez. Zorunludur ve benzersiz olmalıdır.

Parametreler

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

Return

SelectionInput: Zincirleme için kullanılan bu nesne.


setId(id)

Değiştirilecek widget'ı tanımlamak için kullanılan benzersiz kimliği ayarlar. Widget mutasyonu yalnızca eklentilerde desteklenir.

Parametreler

AdTürAçıklama
idString64 karakterle sınırlı ve `[a-zA-Z0-9-]+` biçiminde olan widget'ın kimliği.

Return

Widget: Zincirleme için kullanılan 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 kullanılan bu nesne.


setMultiSelectMinQueryLength(queryLength)

Uygulamanın otomatik tamamlamayı sorgulamadan ve kartta önerilen öğeleri göstermeden önce kullanıcının girdiği metin karakteri 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 kullanılan 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 kullanılan 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 eklentileri için kullanılamaz.

Parametreler

AdTürAçıklama
platformDataSourcePlatformDataSourceVeri kaynağı.

Return

SelectionInput: Zincirleme için kullanılan bu nesne.


setTitle(title)

Başlığı, giriş alanının önünde gösterilecek şekilde ayarlar.

Parametreler

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

Return

SelectionInput: Zincirleme için kullanılan 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 kullanılan bu nesne.


setVisibility(visibility)

Widget'ın görünürlüğünü ayarlar. Varsayılan değer "VISIBLE"dır.

Parametreler

AdTürAçıklama
visibilityVisibilityWidget'ın Visibility.

Return

Widget: Zincirleme için kullanılan Nesne.