Class Chip

चिप

आइकॉन और टेक्स्ट लेबल वाला Chip. ज़रूरत पड़ने पर, चिप को बंद किया जा सकता है.

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

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

तरीके

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

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

setAltText(altText)

सुलभता के लिए, चिप का वैकल्पिक टेक्स्ट सेट करता है. अगर इस विकल्प को सेट नहीं किया जाता है, तो डिफ़ॉल्ट रूप से वह टेक्स्ट दिखता है जो चिप पर दिखता है.

पैरामीटर

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

वापसी का टिकट

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

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

वापसी का टिकट

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

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

वापसी का टिकट

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

setDisabled(disabled)

इससे यह सेट होता है कि चिप बंद है या नहीं. बंद किए गए चिप पर स्लेटी रंग का निशान दिखता है और उस पर क्लिक नहीं किया जा सकता. 

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

पैरामीटर

नामटाइपब्यौरा
disabledBooleanबंद होने की स्थिति.

वापसी का टिकट

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

setIcon(icon)

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

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

पैरामीटर

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

वापसी का टिकट

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

setLabel(label)

चिप का टाइटल सेट करता है. ज़रूरी है. 

const chip = CardService.newChip().setLabel('bug Report');

पैरामीटर

नामटाइपब्यौरा
labelStringवह टेक्स्ट जो दिखाना है.

वापसी का टिकट

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

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

वापसी का टिकट

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

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

वापसी का टिकट

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

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

पैरामीटर

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

वापसी का टिकट

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