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

तरीके

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

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

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

वापसी का टिकट

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


setBottomLabel(text)

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

पैरामीटर

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

वापसी का टिकट

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


setButton(button)

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

पैरामीटर

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

वापसी का टिकट

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


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

वापसी का टिकट

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


setEndIcon(endIcon)

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

पैरामीटर

नामटाइपब्यौरा
endIconIconImageजो आइकॉन जोड़ना है.

वापसी का टिकट

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


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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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


setStartIcon(startIcon)

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

पैरामीटर

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

वापसी का टिकट

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


setSwitchControl(switchToSet)

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

पैरामीटर

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

वापसी का टिकट

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


setText(text)

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

पैरामीटर

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

वापसी का टिकट

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


setTopLabel(text)

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

पैरामीटर

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

वापसी का टिकट

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


setWrapText(wrapText)

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

पैरामीटर

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

वापसी का टिकट

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