Class DecoratedText

DecoratedText

यह एक ऐसा विजेट है जो टेक्स्ट दिखाता है. इसमें सजावट के लिए विकल्प भी दिए गए हैं. संभावित कुंजियों में एक आइकॉन, ऊपर दिया गया लेबल, और नीचे दिया गया लेबल शामिल है. setText(text) और DecoratedText, DecoratedText, setTopLabel(text) या setBottomLabel(text) में से किसी एक का इस्तेमाल करके, टेक्स्ट कॉन्टेंट और किसी एक कुंजी को सेट करना ज़रूरी है. इस क्लास को KeyValue की जगह इस्तेमाल किया जा सकता है.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
addEventAction(eventAction)	Widget	विजेट पर की जा सकने वाली इवेंट कार्रवाई जोड़ता है.
setAuthorizationAction(action)	DecoratedText	यह अनुमति देने वाली कार्रवाई सेट करता है. इससे ऑब्जेक्ट पर क्लिक करने पर, अनुमति देने वाले फ़्लो के लिए एक यूआरएल खुलता है.
setBottomLabel(text)	DecoratedText	इस विकल्प की मदद से, लेबल टेक्स्ट को कुंजी के तौर पर इस्तेमाल किया जा सकता है. यह टेक्स्ट कॉन्टेंट के नीचे दिखता है.
setButton(button)	DecoratedText	इस एट्रिब्यूट की वैल्यू सेट करके, टेक्स्ट के दाईं ओर दिखने वाला Button तय किया जाता है.
setComposeAction(action, composedEmailType)	DecoratedText	यह ऑब्जेक्ट पर क्लिक करने पर, ड्राफ़्ट ईमेल बनाने वाली कार्रवाई सेट करता है.
setEndIcon(endIcon)	DecoratedText	यह विकल्प, कॉन्टेंट की दाईं ओर दिखने वाला IconImage सेट करता है.
setId(id)	Widget	यह कुकी, असाइन किया गया यूनीक आईडी सेट करती है. इसका इस्तेमाल, बदले जाने वाले विजेट की पहचान करने के लिए किया जाता है.
setOnClickAction(action)	DecoratedText	यह ऑब्जेक्ट पर क्लिक करने पर, कार्रवाई को सेट करता है.
setOnClickOpenLinkAction(action)	DecoratedText	यह एक ऐसा ऐक्शन सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, टैब में यूआरएल खोलता है.
setOpenLink(openLink)	DecoratedText	इस विकल्प की मदद से, ऑब्जेक्ट पर क्लिक करने पर खुलने वाला यूआरएल सेट किया जाता है.
setStartIcon(startIcon)	DecoratedText	इस विकल्प से, टेक्स्ट कॉन्टेंट से पहले दिखने वाला वैकल्पिक IconImage सेट किया जाता है.
setSwitchControl(switchToSet)	DecoratedText	यह विकल्प, कॉन्टेंट की दाईं ओर दिखने वाला Switch सेट करता है.
setText(text)	DecoratedText	वैल्यू के तौर पर इस्तेमाल किए जाने वाले टेक्स्ट को सेट करता है.
setTopLabel(text)	DecoratedText	इस विकल्प की मदद से, लेबल टेक्स्ट को मुख्य टेक्स्ट के तौर पर सेट किया जाता है. यह टेक्स्ट कॉन्टेंट के ऊपर दिखता है.
setVisibility(visibility)	Widget	इससे विजेट के दिखने की सेटिंग सेट की जाती है.
setWrapText(wrapText)	DecoratedText	इससे यह तय किया जाता है कि वैल्यू का टेक्स्ट एक लाइन में दिखेगा या कई लाइनों में.

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

addEventAction(eventAction)

विजेट पर की जा सकने वाली इवेंट कार्रवाई जोड़ता है.

पैरामीटर

नाम	टाइप	ब्यौरा
eventAction	EventAction	जोड़ने के लिए EventAction.

वापसी का टिकट

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

---

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	यह ऑब्जेक्ट, इस एलिमेंट पर क्लिक करने पर अनुमति से जुड़ी कार्रवाई के बारे में बताता है.

वापसी का टिकट

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

---

setBottomLabel(text)

इस विकल्प की मदद से, लेबल टेक्स्ट को कुंजी के तौर पर इस्तेमाल किया जा सकता है. यह टेक्स्ट कॉन्टेंट के नीचे दिखता है.

पैरामीटर

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

वापसी का टिकट

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

---

setButton(button)

इस एट्रिब्यूट की वैल्यू सेट करके, टेक्स्ट के दाईं ओर दिखने वाला Button तय किया जाता है. DecoratedText में सिर्फ़ एक बटन या एक स्विच इस्तेमाल किया जा सकता है.

पैरामीटर

नाम	टाइप	ब्यौरा
button	Button	जोड़ने के लिए बटन.

वापसी का टिकट

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

---

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 वैल्यू यह तय करती है कि कंपोज़ किया गया ड्राफ़्ट, स्टैंडअलोन ड्राफ़्ट है या जवाब का ड्राफ़्ट.

वापसी का टिकट

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

---

setEndIcon(endIcon)

यह विकल्प, कॉन्टेंट की दाईं ओर दिखने वाला IconImage सेट करता है. DecoratedText में सिर्फ़ एक बटन, एक स्विच या एक आइकॉन का इस्तेमाल किया जा सकता है.

पैरामीटर

नाम	टाइप	ब्यौरा
endIcon	IconImage	जोड़ने के लिए आइकॉन.

वापसी का टिकट

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

---

setId(id)

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

पैरामीटर

नाम	टाइप	ब्यौरा
id	String	यह विजेट का आईडी होता है. इसमें ज़्यादा से ज़्यादा 64 वर्ण हो सकते हैं. इसका फ़ॉर्मैट `[a-zA-Z0-9-]+` होता है.

वापसी का टिकट

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

---

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	इस एलिमेंट पर क्लिक करने पर की जाने वाली कार्रवाई.

वापसी का टिकट

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

---

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	यह ऑब्जेक्ट, इस एलिमेंट पर क्लिक करने पर लिंक खोलने की कार्रवाई के बारे में बताता है.

वापसी का टिकट

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

---

setOpenLink(openLink)

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

पैरामीटर

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

वापसी का टिकट

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

---

setStartIcon(startIcon)

इस विकल्प से, टेक्स्ट कॉन्टेंट से पहले दिखने वाला वैकल्पिक IconImage सेट किया जाता है.

पैरामीटर

नाम	टाइप	ब्यौरा
startIcon	IconImage	दिखाने के लिए आइकॉन.

वापसी का टिकट

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

---

setSwitchControl(switchToSet)

यह विकल्प, कॉन्टेंट की दाईं ओर दिखने वाला Switch सेट करता है. DecoratedText में सिर्फ़ एक बटन या एक स्विच का इस्तेमाल किया जा सकता है.

पैरामीटर

नाम	टाइप	ब्यौरा
switchToSet	Switch	जोड़ने के लिए स्विच करें.

वापसी का टिकट

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

---

setText(text)

वैल्यू के तौर पर इस्तेमाल किए जाने वाले टेक्स्ट को सेट करता है. इसमें बेसिक एचटीएमएल फ़ॉर्मैटिंग का इस्तेमाल किया जा सकता है. ज़रूरी है.

पैरामीटर

नाम	टाइप	ब्यौरा
text	String	इस विजेट के लिए टेक्स्ट कॉन्टेंट.

वापसी का टिकट

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

---

setTopLabel(text)

इस विकल्प की मदद से, लेबल टेक्स्ट को मुख्य टेक्स्ट के तौर पर सेट किया जाता है. यह टेक्स्ट कॉन्टेंट के ऊपर दिखता है.

पैरामीटर

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

वापसी का टिकट

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

---

setVisibility(visibility)

इससे विजेट के दिखने की सेटिंग सेट की जाती है. डिफ़ॉल्ट वैल्यू `VISIBLE` होती है.

पैरामीटर

नाम	टाइप	ब्यौरा
visibility	Visibility	विजेट का Visibility.

वापसी का टिकट

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

---

setWrapText(wrapText)

इससे यह तय किया जाता है कि वैल्यू का टेक्स्ट एक लाइन में दिखेगा या कई लाइनों में.

पैरामीटर

नाम	टाइप	ब्यौरा
wrapText	Boolean	अगर true है, तो टेक्स्ट को रैप किया जाता है और एक से ज़्यादा लाइनों में दिखाया जाता है. ऐसा न होने पर, टेक्स्ट को छोटा कर दिया जाता है.

वापसी का टिकट

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