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)	TextButton	TextButtonStyle.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)

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

पैरामीटर

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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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

---

setBackgroundColor(backgroundColor)

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

पैरामीटर

नाम	टाइप	ब्यौरा
backgroundColor	String	#आरजीबी फ़ॉर्मैट में रंग.

वापसी का टिकट

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

---

setComposeAction(action, composedEmailType)

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

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

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

// ...

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

पैरामीटर

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

वापसी का टिकट

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

---

setDisabled(disabled)

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

पैरामीटर

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

वापसी का टिकट

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

---

setIcon(icon)

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

पैरामीटर

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

वापसी का टिकट

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

---

setIconUrl(url)

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

पैरामीटर

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

वापसी का टिकट

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

---

setMaterialIcon(icon)

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

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

पैरामीटर

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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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

---

setOpenLink(openLink)

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

पैरामीटर

नाम	टाइप	ब्यौरा
openLink	OpenLink	जिस यूआरएल को खोलना है उसके बारे में जानकारी देने वाला 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();

पैरामीटर

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

वापसी का टिकट

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

---

setText(text)

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

पैरामीटर

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

वापसी का टिकट

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

---

setTextButtonStyle(textButtonStyle)

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

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

पैरामीटर

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

वापसी का टिकट

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