Class TextButton

TextButton

टेक्स्ट लेबल वाला TextButton. ज़रूरत पड़ने पर, बैकग्राउंड का रंग सेट किया जा सकता है और बटन को बंद किया जा सकता है.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
setAltText(altText)TextButtonसुलभता के लिए, बटन का वैकल्पिक टेक्स्ट सेट करता है.
setAuthorizationAction(action)TextButtonअनुमति देने की ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, अनुमति देने के फ़्लो का यूआरएल खोलता है.
setBackgroundColor(backgroundColor)TextButtonTextButtonStyle.FILLED बटन के लिए बैकग्राउंड का रंग सेट करता है.
setComposeAction(action, composedEmailType)TextButtonयह एक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, ईमेल का ड्राफ़्ट बनाता है.
setDisabled(disabled)TextButtonयह सेट करता है कि बटन बंद है या नहीं.
setIcon(icon)TextButtonबटन पर दिखाने के लिए, पहले से तय किया गया Icon सेट करता है.
setIconUrl(url)TextButtonइस बटन के आइकॉन के तौर पर इस्तेमाल करने के लिए, किसी इमेज का यूआरएल सेट करता है.
setMaterialIcon(icon)TextButtonमटीरियल डिज़ाइन आइकॉन सेट करता है.
setOnClickAction(action)TextButtonऑब्जेक्ट पर क्लिक करने पर होने वाली कार्रवाई सेट करता है.
setOnClickOpenLinkAction(action)TextButtonयह एक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, टैब में यूआरएल खोलता है.
setOpenLink(openLink)TextButtonऑब्जेक्ट पर क्लिक करने पर खुलने वाला यूआरएल सेट करता है.
setOverflowMenu(menu)TextButtonऑब्जेक्ट पर क्लिक करने पर खुलने वाला पॉप-अप मेन्यू सेट करता है.
setText(text)TextButtonबटन पर दिखने वाला टेक्स्ट सेट करता है.
setTextButtonStyle(textButtonStyle)TextButtonबटन की स्टाइल सेट करता है.

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

setAltText(altText)

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

पैरामीटर

नामटाइपब्यौरा
altTextStringइस बटन को असाइन करने के लिए वैकल्पिक टेक्स्ट.

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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


setBackgroundColor(backgroundColor)

TextButtonStyle.FILLED बटन के लिए बैकग्राउंड का रंग सेट करता है. अगर किसी TextButtonStyle.FILLED बटन के लिए सेट नहीं किया गया है, तो बटन, ऐड-ऑन manifest में तय किए गए सेकंडरी कलर का इस्तेमाल करता है. यह तरीका TextButtonStyle.OUTLINED बटन के लिए काम नहीं करता.

पैरामीटर

नामटाइपब्यौरा
backgroundColorString#rgb फ़ॉर्मैट में रंग.

वापसी का टिकट

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


setComposeAction(action, composedEmailType)

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

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

// ...

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

// ...

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

पैरामीटर

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

वापसी का टिकट

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


setDisabled(disabled)

यह सेट करता है कि बटन बंद है या नहीं. बंद किए गए बटन का रंग धूसर हो जाता है और उस पर क्लिक नहीं किया जा सकता.

पैरामीटर

नामटाइपब्यौरा
disabledBooleanबंद होने की स्थिति.

वापसी का टिकट

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


setIcon(icon)

बटन पर दिखाने के लिए, पहले से तय किया गया Icon सेट करता है. बटन की इमेज तय करने के लिए, इस या setIconUrl(url) का इस्तेमाल करना ज़रूरी है.

पैरामीटर

नामटाइपब्यौरा
iconIconपहले से तय की गई Icon वैल्यू में से कोई एक.

वापसी का टिकट

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


setIconUrl(url)

इस बटन के आइकॉन के तौर पर इस्तेमाल करने के लिए, किसी इमेज का यूआरएल सेट करता है. बटन की इमेज तय करने के लिए, इस या setIcon(icon) का इस्तेमाल करना ज़रूरी है.

पैरामीटर

नामटाइपब्यौरा
urlStringहोस्ट की गई इमेज का यूआरएल पता, जिसे इस बटन के आइकॉन के तौर पर इस्तेमाल किया जाएगा.

वापसी का टिकट

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


setMaterialIcon(icon)

मटीरियल डिज़ाइन आइकॉन सेट करता है.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

पैरामीटर

नामटाइपब्यौरा
iconMaterialIconमटीरियल डिज़ाइन आइकॉन.

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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


setOverflowMenu(menu)

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

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

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

पैरामीटर

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

वापसी का टिकट

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


setText(text)

बटन पर दिखने वाला टेक्स्ट सेट करता है.

पैरामीटर

नामटाइपब्यौरा
textStringबटन पर दिखने वाला टेक्स्ट.

वापसी का टिकट

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


setTextButtonStyle(textButtonStyle)

बटन की स्टाइल सेट करता है. अगर यह सेट नहीं है, तो यह डिफ़ॉल्ट रूप से TextButtonStyle.OUTLINED बटन पर सेट होता है.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

पैरामीटर

नामटाइपब्यौरा
textButtonStyleTextButtonStyleबटन का स्टाइल.

वापसी का टिकट

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