Class ImageButton

ImageButton

एक ImageButton, जिस पर इमेज दिख रही है.

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

const 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	इस बटन के आइकॉन के तौर पर इस्तेमाल की जाने वाली इमेज का यूआरएल सेट करता है.
setImageButtonStyle(imageButtonStyle)	ImageButton	बटन की स्टाइल सेट करता है.
setMaterialIcon(icon)	ImageButton	इस विकल्प से, मटीरियल डिज़ाइन आइकॉन सेट किया जाता है.
setOnClickAction(action)	ImageButton	यह ऑब्जेक्ट पर क्लिक करने पर, कार्रवाई को सेट करता है.
setOnClickOpenLinkAction(action)	ImageButton	यह एक ऐसा ऐक्शन सेट करता है जो ऑब्जेक्ट पर क्लिक करने पर, टैब में यूआरएल खोलता है.
setOpenLink(openLink)	ImageButton	इस विकल्प की मदद से, ऑब्जेक्ट पर क्लिक करने पर खुलने वाला यूआरएल सेट किया जाता है.
setOverflowMenu(menu)	ImageButton	इस विकल्प का इस्तेमाल करके, ऑब्जेक्ट पर क्लिक करने पर खुलने वाला पॉप-अप मेन्यू सेट किया जाता है.

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

setAltText(altText)

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

पैरामीटर

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

वापसी का टिकट

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

---

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

वापसी का टिकट

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

---

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

वापसी का टिकट

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

---

setIcon(icon)

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

पैरामीटर

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

वापसी का टिकट

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

---

setIconUrl(url)

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

पैरामीटर

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

वापसी का टिकट

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

---

setImageButtonStyle(imageButtonStyle)

बटन की स्टाइल सेट करता है. अगर इसे सेट नहीं किया जाता है, तो यह डिफ़ॉल्ट रूप से ImageButtonStyle.BORDERLESS बटन पर सेट होता है.

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

डेवलपर के लिए उपलब्ध: यह सुविधा, Google Workspace Developer Preview Program के तहत उपलब्ध है. इस प्रोग्राम के तहत, कुछ सुविधाओं को रिलीज़ होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

पैरामीटर

नाम	टाइप	ब्यौरा
imageButtonStyle	ImageButtonStyle	बटन का स्टाइल.

वापसी का टिकट

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

---

setMaterialIcon(icon)

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

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

पैरामीटर

नाम	टाइप	ब्यौरा
icon	MaterialIcon	मटेरियल डिज़ाइन आइकॉन.

वापसी का टिकट

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

---

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

वापसी का टिकट

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

---

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

वापसी का टिकट

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

---

setOpenLink(openLink)

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

पैरामीटर

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

वापसी का टिकट

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

---

setOverflowMenu(menu)

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

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

डेवलपर के लिए उपलब्ध: यह सुविधा, Google Workspace Developer Preview Program के तहत उपलब्ध है. इस प्रोग्राम के तहत, कुछ सुविधाओं को रिलीज़ होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

पैरामीटर

नाम	टाइप	ब्यौरा
menu	OverflowMenu	यह ऑब्जेक्ट, उस ओवरफ़्लो मेन्यू के बारे में बताता है जिसे इस एलिमेंट पर क्लिक करने पर दिखाना है.

वापसी का टिकट

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