Class Action

कार्रवाई

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

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

var 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 अपडेट हो जाता है.

विस्तृत दस्तावेज़

addRequiredWidget(requiredWidget)

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

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

var textInput = CardService.newTextInput()
    .setFieldName("text_input_1")
    .setTitle("Text input title")

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

पैरामीटर

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

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

setAllWidgetsAreRequired(allWidgetsAreRequired)

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

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

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

पैरामीटर

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

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

setFunctionName(functionName)

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

पैरामीटर

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

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

setInteraction(interaction)

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

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

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

पैरामीटर

नामटाइपब्यौरा
interactionInteractionतय किया जाने वाला इंटरैक्शन.

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

setLoadIndicator(loadIndicator)

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

पैरामीटर

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

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

setParameters(parameters)

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

पैरामीटर

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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

Action — चेन बनाने के लिए यह ऑब्जेक्ट.

ऐसे तरीके जो अब काम नहीं करते