Class Image

इमेज

ऐसा विजेट जो एक इमेज दिखाता है. इमेज काटने के बारे में जानकारी के लिए, ImageCropStyle देखें.

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

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addEventAction(eventAction)Widgetविजेट पर की जा सकने वाली इवेंट कार्रवाई जोड़ता है.
setAltText(altText)Imageइस विकल्प का इस्तेमाल, इमेज के वैकल्पिक टेक्स्ट को सेट करने के लिए किया जाता है, ताकि इमेज को ऐक्सेस किया जा सके.
setAuthorizationAction(action)Imageयह अनुमति देने वाली कार्रवाई सेट करता है. इससे ऑब्जेक्ट पर क्लिक करने पर, अनुमति देने वाले फ़्लो के लिए एक यूआरएल खुलता है.
setComposeAction(action, composedEmailType)Imageयह ऑब्जेक्ट पर क्लिक करने पर, ईमेल का ड्राफ़्ट बनाने वाली कार्रवाई सेट करता है.
setId(id)Widgetयह कुकी, असाइन किया गया यूनीक आईडी सेट करती है. इसका इस्तेमाल, बदले जाने वाले विजेट की पहचान करने के लिए किया जाता है.
setImageUrl(url)Imageयह विकल्प, इमेज का यूआरएल या डेटा स्ट्रिंग देकर, इस्तेमाल की जाने वाली इमेज सेट करता है.
setOnClickAction(action)Imageयह ऑब्जेक्ट पर क्लिक करने पर होने वाली कार्रवाई को सेट करता है.
setOnClickOpenLinkAction(action)Imageयह एक ऐसा ऐक्शन सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, टैब में यूआरएल खोलता है.
setOpenLink(openLink)Imageइस विकल्प का इस्तेमाल करके, ऑब्जेक्ट पर क्लिक करने पर खुलने वाला यूआरएल सेट किया जाता है.
setVisibility(visibility)Widgetइससे विजेट के दिखने की सेटिंग सेट की जाती है.

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

addEventAction(eventAction)

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

पैरामीटर

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

वापसी का टिकट

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

setAltText(altText)

इस विकल्प का इस्तेमाल, इमेज के वैकल्पिक टेक्स्ट को सेट करने के लिए किया जाता है, ताकि इमेज को ऐक्सेस किया जा सके. ज़रूरी है.

पैरामीटर

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

वापसी का टिकट

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

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

वापसी का टिकट

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

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

वापसी का टिकट

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

setId(id)

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

पैरामीटर

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

वापसी का टिकट

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

setImageUrl(url)

यह विकल्प, इमेज का यूआरएल या डेटा स्ट्रिंग देकर, इस्तेमाल की जाने वाली इमेज सेट करता है. ज़रूरी है.

दिया गया यूआरएल, सार्वजनिक तौर पर ऐक्सेस किया जा सकने वाला यूआरएल या base64 एन्कोड की गई इमेज स्ट्रिंग हो सकता है. बाद वाला कोड पाने के लिए, यहां दिए गए कोड का इस्तेमाल करके, Google Drive में मौजूद किसी इमेज से एन्कोड की गई इमेज स्ट्रिंग बनाई जा सकती है. इसके बाद, उस स्ट्रिंग को सेव किया जा सकता है, ताकि बाद में setImageUrl(url) के साथ उसका इस्तेमाल किया जा सके. इस तरीके से, आपके ऐड-ऑन को सार्वजनिक तौर पर उपलब्ध इमेज यूआरएल को ऐक्सेस करने की ज़रूरत नहीं पड़ती: 

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

पैरामीटर

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

वापसी का टिकट

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

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

वापसी का टिकट

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

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

वापसी का टिकट

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

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

पैरामीटर

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

वापसी का टिकट

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

setVisibility(visibility)

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

पैरामीटर

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

वापसी का टिकट

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