Class ImageButton

ImageButton

ImageButton, जिस पर इमेज दिखाई गई है.

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

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
setAltText(altText)ImageButtonसुलभता के लिए, बटन का वैकल्पिक टेक्स्ट सेट करता है.
setAuthorizationAction(action)ImageButtonअनुमति देने की कार्रवाई सेट करता है, जो ऑब्जेक्ट पर क्लिक करने पर अनुमति देने वाले फ़्लो को एक यूआरएल खोलता है.
setComposeAction(action, composedEmailType)ImageButtonऑब्जेक्ट के क्लिक होने पर, ड्राफ़्ट ईमेल बनाने वाली कार्रवाई सेट करता है.
setIcon(icon)ImageButtonबटन पर दिखाने के लिए, पहले से तय Icon को सेट करता है.
setIconUrl(url)ImageButtonइस बटन के आइकॉन के तौर पर इस्तेमाल करने के लिए, इमेज का यूआरएल सेट करता है.
setOnClickAction(action)ImageButtonऑब्जेक्ट पर क्लिक होने पर, एक कार्रवाई सेट करता है.
setOnClickOpenLinkAction(action)ImageButtonऑब्जेक्ट को क्लिक करने पर, टैब में यूआरएल खोलने वाली कार्रवाई सेट की जाती है.
setOpenLink(openLink)ImageButtonऑब्जेक्ट के क्लिक होने पर खुलने वाला यूआरएल सेट करता है.

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

setAltText(altText)

सुलभता के लिए, बटन का वैकल्पिक टेक्स्ट सेट करता है. ज़रूरी है.

पैरामीटर

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

रिटर्न

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


setAuthorizationAction(action)

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

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

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

पैरामीटर

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

रिटर्न

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


setComposeAction(action, composedEmailType)

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

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

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

पैरामीटर

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

रिटर्न

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


setIcon(icon)

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

पैरामीटर

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

रिटर्न

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


setIconUrl(url)

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

पैरामीटर

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

रिटर्न

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


setOnClickAction(action)

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

Action पैरामीटर को उस कॉलबैक फ़ंक्शन के बारे में बताना होगा जो ActionResponse ऑब्जेक्ट दिखाता है.

// ...

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

रिटर्न

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


setOnClickOpenLinkAction(action)

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

Action पैरामीटर को उस कॉलबैक फ़ंक्शन के बारे में बताना होगा जो ActionResponseBuilder.setOpenLink(openLink) का इस्तेमाल करके कॉन्फ़िगर किया गया ActionResponse ऑब्जेक्ट दिखाता है.

// ...

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

रिटर्न

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


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

पैरामीटर

नामटाइपब्यौरा
openLinkOpenLinkOpenLink ऑब्जेक्ट, जिसमें खुलने वाले यूआरएल के बारे में जानकारी दी गई है.

रिटर्न

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