Class Button

बटन

यह सभी बटन के लिए एक बेस क्लास है.

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

तरीके

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

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

setAuthorizationAction(action)

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

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

// ...

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

पैरामीटर

नाम	टाइप	ब्यौरा
action	AuthorizationAction	यह ऑब्जेक्ट, इस एलिमेंट पर क्लिक करने पर अनुमति से जुड़ी कार्रवाई के बारे में बताता है.

वापसी का टिकट

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

---

setComposeAction(action, composedEmailType)

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

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

ध्यान दें: इस तरीके से, compose action सेट नहीं होता है. इसका इस्तेमाल compose UI को बड़ा करने के लिए किया जाता है. इसके बजाय, यह तरीका इस यूज़र इंटरफ़ेस (यूआई) एलिमेंट को ऐसे Action से जोड़ता है जो Apps Script में ड्राफ़्ट मैसेज बनाता है. ये मैसेज, कार्रवाई पूरी होने पर Gmail में खुलते हैं.

// ...

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

// ...

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

पैरामीटर

नाम	टाइप	ब्यौरा
action	Action	यह ऑब्जेक्ट, इस एलिमेंट पर क्लिक करने पर, ईमेल लिखने की कार्रवाई के बारे में बताता है.
composedEmailType	ComposedEmailType	यह enum वैल्यू यह तय करती है कि कंपोज़ किया गया ड्राफ़्ट, स्टैंडअलोन ड्राफ़्ट है या जवाब का ड्राफ़्ट.

वापसी का टिकट

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

---

setOnClickAction(action)

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

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

// ...

const 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();
}

पैरामीटर

नाम	टाइप	ब्यौरा
action	Action	इस एलिमेंट पर क्लिक करने पर की जाने वाली कार्रवाई.

वापसी का टिकट

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

---

setOnClickOpenLinkAction(action)

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

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

// ...

const 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();
}

पैरामीटर

नाम	टाइप	ब्यौरा
action	Action	यह ऑब्जेक्ट, इस एलिमेंट पर क्लिक करने पर लिंक खोलने की कार्रवाई के बारे में बताता है.

वापसी का टिकट

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

---

setOpenLink(openLink)

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

पैरामीटर

नाम	टाइप	ब्यौरा
openLink	OpenLink	खोलने के लिए यूआरएल की जानकारी देने वाला OpenLink ऑब्जेक्ट.

वापसी का टिकट

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

---

setOverflowMenu(menu)

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

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

डेवलपर के लिए उपलब्ध: यह सुविधा, Google Workspace Developer Preview Program के तहत उपलब्ध है. इस प्रोग्राम के तहत, कुछ सुविधाओं को रिलीज़ होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

पैरामीटर

नाम	टाइप	ब्यौरा
menu	OverflowMenu	यह ऑब्जेक्ट, उस ओवरफ़्लो मेन्यू के बारे में बताता है जिसे इस एलिमेंट पर क्लिक करने पर दिखाना है.

वापसी का टिकट

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