Class Action

कार्रवाई

यह एक ऐसी कार्रवाई है जिससे यूज़र इंटरफ़ेस (यूआई) एलिमेंट के साथ इंटरैक्ट किया जा सकता है. यह कार्रवाई सीधे तौर पर क्लाइंट पर नहीं होती. इसके बजाय, यह वैकल्पिक पैरामीटर के साथ Apps Script कॉलबैक फ़ंक्शन को चालू करती है.

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

const image = CardService.newImage().setOnClickAction(
    CardService.newAction().setFunctionName('handleImageClick').setParameters({
      imageSrc: 'carImage'
    }),
);

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
addRequiredWidget(requiredWidget)	Action	इस कार्रवाई के लिए ज़रूरी विजेट के नाम जोड़ता है, ताकि इसे मान्य सबमिशन के तौर पर स्वीकार किया जा सके.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	इससे पता चलता है कि इस कार्रवाई के लिए, सभी विजेट से इनपुट की ज़रूरत है या नहीं.
setFunctionName(functionName)	Action	इससे कॉल किए जाने वाले कॉलबैक फ़ंक्शन का नाम सेट होता है.
setInteraction(interaction)	Action	यह कुकी, उपयोगकर्ता के साथ इंटरैक्शन सेट करती है. इसकी ज़रूरत सिर्फ़ तब होती है, जब कोई डायलॉग बॉक्स खोला जाता है.
setLoadIndicator(loadIndicator)	Action	यह विकल्प, कार्रवाई के दौरान दिखने वाले लोडिंग इंडिकेटर को सेट करता है.
setParameters(parameters)	Action	इस विकल्प की मदद से, कस्टम पैरामीटर को कॉलबैक फ़ंक्शन में पास किया जा सकता है.
setPersistValues(persistValues)	Action	इससे पता चलता है कि फ़ॉर्म की वैल्यू, क्लाइंट की वैल्यू से तय होती हैं या सर्वर की वैल्यू से. ऐसा तब होता है, जब कार्रवाई के जवाब से फ़ॉर्म के Card अपडेट हो जाते हैं.

ऐसे तरीके जिन्हें अब इस्तेमाल नहीं किया जा सकता

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
setMethodName(functionName)	Action

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

addRequiredWidget(requiredWidget)

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

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

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_1')
                      .setTitle('Text input title');

// Creates a footer button that requires an input from the above TextInput
// Widget.
const action = CardService.newAction()
                   .setFunctionName('notificationCallback')
                   .addRequiredWidget('text_input_1');
const fixedFooter = CardService.newFixedFooter().setPrimaryButton(
    CardService.newTextButton().setText('help').setOnClickAction(action),
);

पैरामीटर

नाम	टाइप	ब्यौरा
requiredWidget	String	इस कार्रवाई के लिए ज़रूरी विजेट का नाम.

वापसी का टिकट

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

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

इससे पता चलता है कि इस कार्रवाई के लिए, सभी विजेट से इनपुट की ज़रूरत है या नहीं.

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

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
                   .setText('Create notification')
                   .setOnClickAction(
                       CardService.newAction().setAllWidgetsAreRequired(true));

पैरामीटर

नाम	टाइप	ब्यौरा
allWidgetsAreRequired	Boolean	कार्रवाई के लिए, सभी विजेट से इनपुट की ज़रूरत है या नहीं. डिफ़ॉल्ट रूप से, यह false पर सेट होता है.

वापसी का टिकट

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

---

setFunctionName(functionName)

इससे कॉल किए जाने वाले कॉलबैक फ़ंक्शन का नाम सेट होता है. ज़रूरी है.

पैरामीटर

नाम	टाइप	ब्यौरा
functionName	String	फ़ंक्शन का नाम. शामिल की गई लाइब्रेरी के फ़ंक्शन इस्तेमाल किए जा सकते हैं. जैसे, Library.libFunction1.

वापसी का टिकट

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

---

setInteraction(interaction)

यह कुकी, उपयोगकर्ता के साथ इंटरैक्शन सेट करती है. इसकी ज़रूरत सिर्फ़ तब होती है, जब कोई डायलॉग बॉक्स खोला जाता है. अगर इसे तय नहीं किया गया है, तो ऐप्लिकेशन सामान्य तौर पर Action को लागू करके जवाब देता है. जैसे, लिंक खोलना या फ़ंक्शन चलाना.

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

const action = CardService.newAction()
                   .setFunctionName('handleDialog')
                   .setInteraction(CardService.Interaction.OPEN_DIALOG);

पैरामीटर

नाम	टाइप	ब्यौरा
interaction	Interaction	वह इंटरैक्शन जिसे सेट करना है.

वापसी का टिकट

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

---

setLoadIndicator(loadIndicator)

यह विकल्प, कार्रवाई के दौरान दिखने वाले लोडिंग इंडिकेटर को सेट करता है.

पैरामीटर

नाम	टाइप	ब्यौरा
loadIndicator	LoadIndicator	दिखाने के लिए इंडिकेटर.

वापसी का टिकट

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

---

setParameters(parameters)

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

पैरामीटर

नाम	टाइप	ब्यौरा
parameters	Object	कुंजियां और वैल्यू, दोनों स्ट्रिंग होनी चाहिए.

वापसी का टिकट

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

---

setPersistValues(persistValues)

इससे पता चलता है कि फ़ॉर्म की वैल्यू, क्लाइंट की वैल्यू से तय होती हैं या सर्वर की वैल्यू से. ऐसा तब होता है, जब कार्रवाई के जवाब से फ़ॉर्म के Card अपडेट हो जाते हैं. true पर सेट होने पर, सर्वर से मिले जवाब के बाद भी क्लाइंट की वैल्यू बनी रहती हैं. false पर सेट होने पर, सर्वर की वैल्यू, फ़ॉर्म की वैल्यू को बदल देती हैं. यह डिफ़ॉल्ट रूप से false पर सेट होता है.

क्लाइंट वैल्यू को सेव करके रखने से, ऐसी स्थितियों से बचा जा सकता है जहां उपयोगकर्ता के बदलाव करने के बाद, फ़ॉर्म में अचानक बदलाव हो जाता है. उदाहरण के लिए, अगर कोई उपयोगकर्ता फ़ॉर्म सबमिट करने के बाद, लेकिन सर्वर के जवाब देने से पहले TextInput में बदलाव करता है. अगर वैल्यू सेव रहती हैं, तो सर्वर के जवाब से अपडेट होने के बाद भी, उपयोगकर्ता के किए गए बदलाव बने रहते हैं. अगर वैल्यू सेव नहीं रहती हैं, तो फ़ॉर्म की वैल्यू उस वैल्यू पर वापस आ जाती है जिसे उपयोगकर्ता ने फ़ॉर्म में सबमिट किया था.Card

क्लाइंट की वैल्यू सेव होने से, आपकी स्क्रिप्ट को फ़ॉर्म फ़ील्ड खाली करने या फ़ॉर्म की वैल्यू बदलने में समस्या आ सकती है. इसलिए, इस तरह की सुविधा के लिए वैल्यू सेव करने की सुविधा चालू न करें. अगर आपको डेटा को सेव नहीं करना है, तो हमारा सुझाव है कि इवेंट के लिए LoadIndicator.SPINNER का इस्तेमाल करें. ऐसा इसलिए, क्योंकि इससे यूज़र इंटरफ़ेस (यूआई) लॉक हो जाता है और सर्वर के जवाब देने से पहले, उपयोगकर्ता को बदलाव करने से रोका जाता है. इसके अलावा, LoadIndicator.NONE का इस्तेमाल किया जा सकता है. साथ ही, यह पक्का किया जा सकता है कि फ़ॉर्म के हर एलिमेंट में onChange ऐक्शन हो.

// Creates a button with an action that persists the client's values as the
// on-click action.
const button =
    CardService.newTextButton()
        .setText('Create notification')
        .setOnClickAction(
            CardService.newAction().setPersistValues(true).setFunctionName(
                'functionName'),
        );

पैरामीटर

नाम	टाइप	ब्यौरा
persistValues	Boolean	क्या वैल्यू सेव करनी हैं. यह डिफ़ॉल्ट रूप से false पर सेट होता है.

वापसी का टिकट

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

ऐसे तरीके जिन्हें अब इस्तेमाल नहीं किया जा सकता

setMethodName(functionName)

अब सेवा में नहीं है. setFunctionName(functionName) के लिए लेगसी एलियास.

पैरामीटर

नाम	टाइप	ब्यौरा
functionName	String	फ़ंक्शन का नाम. शामिल की गई लाइब्रेरी के फ़ंक्शन इस्तेमाल किए जा सकते हैं. जैसे, Library.libFunction1.

वापसी का टिकट

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