Class KeyValue

कुंजीवैल्यू

अब काम नहीं करता. इस क्लास का इस्तेमाल बंद कर दिया गया है. इसलिए, इसे नई स्क्रिप्ट में इस्तेमाल नहीं किया जाना चाहिए.

यह क्लास अब काम नहीं करती. इसके बजाय, DecoratedText का इस्तेमाल करें.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
setAuthorizationAction(action)KeyValueअनुमति देने की ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, अनुमति देने के फ़्लो का यूआरएल खोलता है.
setComposeAction(action, composedEmailType)KeyValueयह एक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, ईमेल का ड्राफ़्ट बनाता है.
setOnClickAction(action)KeyValueऑब्जेक्ट पर क्लिक करने पर होने वाली कार्रवाई सेट करता है.
setOnClickOpenLinkAction(action)KeyValueयह एक ऐसी कार्रवाई सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, टैब में यूआरएल खोलता है.
setOpenLink(openLink)KeyValueऑब्जेक्ट पर क्लिक करने पर खुलने वाला यूआरएल सेट करता है.
तरीकारिटर्न टाइपसंक्षिप्त विवरण
setBottomLabel(text)KeyValueलेबल टेक्स्ट को सेट करता है, ताकि उसका इस्तेमाल की-वर्ड के तौर पर किया जा सके.
setButton(button)KeyValueसंदर्भ की दाईं ओर दिखने वाले Button को सेट करता है.
setContent(text)KeyValueवैल्यू के तौर पर इस्तेमाल किए जाने वाले टेक्स्ट को सेट करता है.
setIcon(icon)KeyValueआइकॉन को बटन के तौर पर सेट करता है.
setIconAltText(altText)KeyValueआइकॉन के लिए वैकल्पिक टेक्स्ट सेट करता है.
setIconUrl(url)KeyValueइस एट्रिब्यूट की मदद से, आइकॉन का यूआरएल सेट किया जाता है. इसका इस्तेमाल, पासकोड के तौर पर किया जाता है.
setMultiline(multiline)KeyValueयह सेट करता है कि वैल्यू टेक्स्ट को एक लाइन में दिखाया जाए या एक से ज़्यादा लाइनों में.
setSwitch(switchToSet)KeyValueकॉन्टेंट की दाईं ओर दिखने वाले Switch को सेट करता है.
setTopLabel(text)KeyValueलेबल टेक्स्ट को सेट करता है, ताकि उसका इस्तेमाल की-वर्ड के तौर पर किया जा सके.

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

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

वापसी का टिकट

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


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(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

पैरामीटर

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

वापसी का टिकट

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


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

वापसी का टिकट

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


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

वापसी का टिकट

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


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

पैरामीटर

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

वापसी का टिकट

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

अब काम न करने वाले तरीके

अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

नामटाइपब्यौरा
textStringलेबल का टेक्स्ट. ध्यान दें: यह बेसिक एचटीएमएल फ़ॉर्मैटिंग के साथ काम नहीं करता.

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

आइकॉन को बटन के तौर पर सेट करता है.

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

आइकॉन के लिए वैकल्पिक टेक्स्ट सेट करता है.

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

नामटाइपब्यौरा
multilineBooleanमल्टीलाइन सेटिंग.

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

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

वापसी का टिकट

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


अब काम नहीं करता. इस फ़ंक्शन का इस्तेमाल बंद कर दिया गया है. इसलिए, नई स्क्रिप्ट में इसका इस्तेमाल नहीं किया जाना चाहिए.

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

पैरामीटर

नामटाइपब्यौरा
textStringलेबल का टेक्स्ट. ध्यान दें: यह बेसिक एचटीएमएल फ़ॉर्मैटिंग के साथ काम नहीं करता.

वापसी का टिकट

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