Class SelectionInput

SelectionInput

यह एक इनपुट फ़ील्ड होता है. इसमें पहले से तय किए गए विकल्पों में से कोई विकल्प चुना जा सकता है.

यह सुविधा, सिर्फ़ SelectionInputType.DROP_DOWN और SelectionInputType.MULTI_SELECT मेन्यू के लिए, फ़ॉर्म सबमिट करने की पुष्टि करने की सुविधा देती है. जब Action.setAllWidgetsAreRequired(allWidgetsAreRequired) को true पर सेट किया जाता है या इस विजेट को Action.addRequiredWidget(requiredWidget) के ज़रिए तय किया जाता है, तो वैल्यू चुने जाने तक सबमिट करने की कार्रवाई को ब्लॉक कर दिया जाता है.

यह सुविधा, Google Workspace ऐड-ऑन और Google Chat ऐप्लिकेशन के लिए उपलब्ध है. 

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

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addDataSourceConfig(dataSourceConfig)SelectionInputयह विकल्प, सिलेक्शन कंट्रोल के लिए डेटा सोर्स कॉन्फ़िगरेशन सेट करता है.
addEventAction(eventAction)Widgetविजेट पर की जा सकने वाली इवेंट कार्रवाई जोड़ता है.
addItem(text, value, selected)SelectionInputयह एक नया आइटम जोड़ता है जिसे चुना जा सकता है.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputयह एक ऐसा नया आइटम जोड़ता है जिसे एक से ज़्यादा आइटम चुनने वाले मेन्यू के लिए चुना जा सकता है.
setExternalDataSource(action)SelectionInputयह कुकी, बाहरी डेटा सोर्स सेट करती है. जैसे, रिलेशनल डेटाबेस.
setFieldName(fieldName)SelectionInputयह उस कुंजी को सेट करता है जो यूज़र इंटरफ़ेस (यूआई) से इंटरैक्ट करने पर जनरेट होने वाले इवेंट ऑब्जेक्ट में, इस सिलेक्शन इनपुट की पहचान करती है.
setId(id)Widgetयह कुकी, असाइन किया गया यूनीक आईडी सेट करती है. इसका इस्तेमाल, बदले जाने वाले विजेट की पहचान करने के लिए किया जाता है.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputइससे, किसी व्यक्ति के चुने जा सकने वाले आइटम की ज़्यादा से ज़्यादा संख्या सेट की जाती है.
setMultiSelectMinQueryLength(queryLength)SelectionInputयह कुकी, टेक्स्ट के उन वर्णों की संख्या सेट करती है जिन्हें उपयोगकर्ता डालता है. इसके बाद, ऐप्लिकेशन अपने-आप पूरा होने वाली क्वेरी करता है और कार्ड पर सुझाए गए आइटम दिखाता है.
setOnChangeAction(action)SelectionInputयह फ़ंक्शन, Action सेट करता है. इसे तब लागू किया जाता है, जब चुने गए इनपुट में बदलाव होता है.
setPlatformDataSource(platformDataSource)SelectionInputGoogle Workspace से डेटा सोर्स सेट करता है.
setTitle(title)SelectionInputइस विकल्प का इस्तेमाल करके, इनपुट फ़ील्ड से पहले दिखने वाला टाइटल सेट किया जाता है.
setType(type)SelectionInputइस इनपुट का टाइप सेट करता है.
setVisibility(visibility)Widgetइससे विजेट के दिखने की सेटिंग सेट की जाती है.

ज़्यादा जानकारी वाला दस्तावेज़

addDataSourceConfig(dataSourceConfig)

यह विकल्प, सिलेक्शन कंट्रोल के लिए डेटा सोर्स कॉन्फ़िगरेशन सेट करता है. इस फ़ील्ड से, डेटा सोर्स पर ज़्यादा कंट्रोल मिलता है. यह फ़ील्ड ज़रूरी नहीं है. 

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

पैरामीटर

नामटाइपब्यौरा
dataSourceConfigDataSourceConfigचुने गए इनपुट पर लागू किया जाने वाला डेटा सोर्स कॉन्फ़िगरेशन.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

addEventAction(eventAction)

विजेट पर की जा सकने वाली इवेंट कार्रवाई जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
eventActionEventActionजोड़ने के लिए EventAction.

वापसी का टिकट

Widget — यह ऑब्जेक्ट, चेनिंग के लिए होता है.

addItem(text, value, selected)

यह एक नया आइटम जोड़ता है जिसे चुना जा सकता है.

पैरामीटर

नामटाइपब्यौरा
textObjectइस आइटम के लिए दिखाया जाने वाला टेक्स्ट. स्ट्रिंग नहीं हैं, ऐसे प्रिमिटिव आर्ग्युमेंट अपने-आप स्ट्रिंग में बदल जाते हैं.
valueObjectफ़ॉर्म में डाली गई वह वैल्यू जिसे कॉलबैक के ज़रिए भेजा जाता है. स्ट्रिंग नहीं हैं, ऐसे प्रिमिटिव आर्ग्युमेंट अपने-आप स्ट्रिंग में बदल जाते हैं.
selectedBooleanक्या आइटम डिफ़ॉल्ट रूप से चुना गया है. अगर सिलेक्शन इनपुट सिर्फ़ एक वैल्यू स्वीकार करता है (जैसे, रेडियो बटन या ड्रॉपडाउन मेन्यू के लिए), तो इस फ़ील्ड को सिर्फ़ एक आइटम के लिए सेट करें.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

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

यह एक ऐसा नया आइटम जोड़ता है जिसे एक से ज़्यादा आइटम चुनने वाले मेन्यू के लिए चुना जा सकता है. 

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

पैरामीटर

नामटाइपब्यौरा
textObjectइस आइटम के लिए दिखाया जाने वाला टेक्स्ट. स्ट्रिंग नहीं हैं, ऐसे प्रिमिटिव आर्ग्युमेंट अपने-आप स्ट्रिंग में बदल जाते हैं.
valueObjectफ़ॉर्म में डाली गई वह वैल्यू जिसे कॉलबैक के ज़रिए भेजा जाता है. स्ट्रिंग नहीं हैं, ऐसे प्रिमिटिव आर्ग्युमेंट अपने-आप स्ट्रिंग में बदल जाते हैं.
selectedBooleanक्या आइटम डिफ़ॉल्ट रूप से चुना गया है. अगर सिलेक्शन इनपुट सिर्फ़ एक वैल्यू स्वीकार करता है (जैसे, रेडियो बटन या ड्रॉपडाउन मेन्यू के लिए), तो इस फ़ील्ड को सिर्फ़ एक आइटम के लिए सेट करें.
startIconUriObjectएक से ज़्यादा आइटम चुनने की सुविधा वाले मेन्यू के लिए, आइटम के टेक्स्ट फ़ील्ड के बगल में दिखने वाले आइकॉन का यूआरएल. PNG और JPEG फ़ाइलें इस्तेमाल की जा सकती हैं.
bottomTextObjectएक से ज़्यादा आइटम चुनने वाले मेन्यू के लिए, टेक्स्ट का ब्यौरा या लेबल. यह आइटम के टेक्स्ट फ़ील्ड के नीचे दिखता है.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setExternalDataSource(action)

यह कुकी, बाहरी डेटा सोर्स सेट करती है. जैसे, रिलेशनल डेटाबेस. 

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

पैरामीटर

नामटाइपब्यौरा
actionActionबाहरी डेटा सोर्स.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setFieldName(fieldName)

यह उस कुंजी को सेट करता है जो यूज़र इंटरफ़ेस (यूआई) से इंटरैक्ट करने पर जनरेट होने वाले इवेंट ऑब्जेक्ट में, इस सिलेक्शन इनपुट की पहचान करती है. यह उपयोगकर्ता को नहीं दिखेगा. यह ज़रूरी है और यूनीक होना चाहिए.

पैरामीटर

नामटाइपब्यौरा
fieldNameStringइस इनपुट को असाइन किया जाने वाला नाम.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setId(id)

यह कुकी, असाइन किया गया यूनीक आईडी सेट करती है. इसका इस्तेमाल, बदले जाने वाले विजेट की पहचान करने के लिए किया जाता है. विजेट में बदलाव करने की सुविधा सिर्फ़ ऐड-ऑन में उपलब्ध है.

पैरामीटर

नामटाइपब्यौरा
idStringयह विजेट का आईडी होता है. इसमें ज़्यादा से ज़्यादा 64 वर्ण हो सकते हैं. इसका फ़ॉर्मैट `[a-zA-Z0-9-]+` होता है.

वापसी का टिकट

Widget — यह ऑब्जेक्ट, चेनिंग के लिए है.

setMultiSelectMaxSelectedItems(maxSelectedItems)

इससे, किसी व्यक्ति के चुने जा सकने वाले आइटम की ज़्यादा से ज़्यादा संख्या सेट की जाती है. 

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

पैरामीटर

नामटाइपब्यौरा
maxSelectedItemsIntegerज़्यादा से ज़्यादा आइटम.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setMultiSelectMinQueryLength(queryLength)

यह कुकी, टेक्स्ट के उन वर्णों की संख्या सेट करती है जिन्हें उपयोगकर्ता डालता है. इसके बाद, ऐप्लिकेशन अपने-आप पूरा होने वाली क्वेरी करता है और कार्ड पर सुझाए गए आइटम दिखाता है. 

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

पैरामीटर

नामटाइपब्यौरा
queryLengthIntegerटेक्स्ट वर्णों की संख्या.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setOnChangeAction(action)

यह फ़ंक्शन, Action सेट करता है. इसे तब लागू किया जाता है, जब चुने गए इनपुट में बदलाव होता है.

पैरामीटर

नामटाइपब्यौरा
actionActionकी जाने वाली कार्रवाई.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setPlatformDataSource(platformDataSource)

Google Workspace से डेटा सोर्स सेट करता है. इस कुकी का इस्तेमाल, एक से ज़्यादा आइटम चुनने वाले मेन्यू में आइटम भरने के लिए किया जाता है. 

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );
 यह सुविधा सिर्फ़ Google Chat ऐप्लिकेशन के लिए उपलब्ध है. यह सुविधा, Google Workspace के ऐड-ऑन के लिए उपलब्ध नहीं है.

पैरामीटर

नामटाइपब्यौरा
platformDataSourcePlatformDataSourceडेटा सोर्स.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setTitle(title)

इस विकल्प का इस्तेमाल करके, इनपुट फ़ील्ड से पहले दिखने वाला टाइटल सेट किया जाता है.

पैरामीटर

नामटाइपब्यौरा
titleStringइनपुट फ़ील्ड का टाइटल.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setType(type)

इस इनपुट का टाइप सेट करता है. डिफ़ॉल्ट रूप से, यह CHECKBOX पर सेट होता है.

पैरामीटर

नामटाइपब्यौरा
typeSelectionInputTypeचुने गए आइटम का टाइप.

वापसी का टिकट

SelectionInput — यह ऑब्जेक्ट, चेनिंग के लिए है.

setVisibility(visibility)

इससे विजेट के दिखने की सेटिंग सेट की जाती है. डिफ़ॉल्ट वैल्यू `VISIBLE` होती है.

पैरामीटर

नामटाइपब्यौरा
visibilityVisibilityविजेट का Visibility.

वापसी का टिकट

Widget — यह ऑब्जेक्ट, चेनिंग के लिए होता है.