Class CardAction

CardAction

क्लिक किया जा सकने वाला मेन्यू आइटम, जिसे कार्ड हेडर मेन्यू में जोड़ा गया है.

var action = CardService.newAction();
// Finish building the action...

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
setAuthorizationAction(action)CardActionअनुमति देने की ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर अनुमति देने वाले फ़्लो को यूआरएल खोलता है.
setComposeAction(action, composedEmailType)CardActionऑब्जेक्ट के क्लिक होने पर, ड्राफ़्ट ईमेल बनाने वाली कार्रवाई सेट करता है.
setOnClickAction(action)CardActionएक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट के क्लिक होने पर निष्पादित होती है.
setOnClickOpenLinkAction(action)CardActionयह सेटिंग ऐसी कार्रवाई सेट करती है जो ऑब्जेक्ट पर क्लिक होने पर टैब में एक यूआरएल खोलता है.
setOpenLink(openLink)CardActionऑब्जेक्ट को क्लिक किए जाने पर खुलने वाला यूआरएल सेट करता है.
setText(text)CardActionइस कार्रवाई के लिए मेन्यू टेक्स्ट सेट करता है.

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

setAuthorizationAction(action)

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

यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट में setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) या setComposeAction(action, composedEmailType) में से सिर्फ़ एक सेट हो सकता है.

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

पैरामीटर

नामTypeब्यौरा
actionAuthorizationActionवह ऑब्जेक्ट जो इस एलिमेंट पर क्लिक होने के बाद की जाने वाली अनुमति देने की कार्रवाई तय करता है.

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.


setComposeAction(action, composedEmailType)

ऑब्जेक्ट के क्लिक होने पर, ड्राफ़्ट ईमेल बनाने वाली कार्रवाई सेट करता है. यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट में setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) या setComposeAction(action, composedEmailType) में से सिर्फ़ एक सेट हो सकता है.

Action पैरामीटर में ऐसा कॉलबैक फ़ंक्शन देना ज़रूरी है जो ComposeActionResponseBuilder.setGmailDraft(draft) का इस्तेमाल करके कॉन्फ़िगर किया गया ComposeActionResponse ऑब्जेक्ट दिखाता हो.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

पैरामीटर

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

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.


setOnClickAction(action)

एक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट के क्लिक होने पर निष्पादित होती है. यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट में setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) या setComposeAction(action, composedEmailType) में से सिर्फ़ एक सेट हो सकता है.

Action पैरामीटर के लिए, ऐसा कॉलबैक फ़ंक्शन तय करना ज़रूरी है जो ActionResponse ऑब्जेक्ट दिखाता हो.

// ...

var action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton().setText('Create notification').setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(CardService.newNotification()
          .setText("Some info to display to user"))
      .build();
}

पैरामीटर

नामTypeब्यौरा
actionActionइस एलिमेंट पर क्लिक होने पर की जाने वाली कार्रवाई.

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.


setOnClickOpenLinkAction(action)

यह सेटिंग ऐसी कार्रवाई सेट करती है जो ऑब्जेक्ट पर क्लिक होने पर टैब में एक यूआरएल खोलता है. इस फ़ंक्शन का इस्तेमाल तब करें, जब यूआरएल बनाने की ज़रूरत हो या आपको OpenLink ऑब्जेक्ट बनाने के लिए, दूसरी कार्रवाइयां करने की ज़रूरत हो. यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट में setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) या setComposeAction(action, composedEmailType) में से सिर्फ़ एक सेट हो सकता है.

Action पैरामीटर में ऐसा कॉलबैक फ़ंक्शन देना ज़रूरी है जो ActionResponseBuilder.setOpenLink(openLink) का इस्तेमाल करके कॉन्फ़िगर किया गया ActionResponse ऑब्जेक्ट दिखाता हो.

// ...

var action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl('https://www.google.com'))
      .build();
}

पैरामीटर

नामTypeब्यौरा
actionActionवह ऑब्जेक्ट जो इस एलिमेंट पर क्लिक होने के बाद की जाने वाली ओपन लिंक कार्रवाई के बारे में बताता है.

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.


ऑब्जेक्ट को क्लिक किए जाने पर खुलने वाला यूआरएल सेट करता है. इस फ़ंक्शन का इस्तेमाल तब करें जब यूआरएल को पहले से ही पता हो और उसे सिर्फ़ खोलने की ज़रूरत हो. यूज़र इंटरफ़ेस (यूआई) ऑब्जेक्ट में setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) या setComposeAction(action, composedEmailType) में से सिर्फ़ एक सेट हो सकता है.

पैरामीटर

नामTypeब्यौरा
openLinkOpenLinkएक OpenLink ऑब्जेक्ट, जिसमें खुलने वाले यूआरएल के बारे में जानकारी दी गई है.

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.


setText(text)

इस कार्रवाई के लिए मेन्यू टेक्स्ट सेट करता है.

पैरामीटर

नामTypeब्यौरा
textStringमेन्यू आइटम का टेक्स्ट.

रिटर्न

CardAction — यह ऑब्जेक्ट, चेन करने के लिए है.