ईमेल लिखने की कार्रवाई की मदद से, लिखने के लिए यूज़र इंटरफ़ेस (यूआई) को बढ़ाना

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

ऐड-ऑन 'लिखें' यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करना

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

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

लिखें ऐड-ऑन बनाना

आप इन सामान्य चरणों का पालन करके, किसी ऐड-ऑन में 'लिखें' सुविधा जोड़ सकते हैं:

  1. ऐड-ऑन स्क्रिप्ट प्रोजेक्ट में gmail.composeTrigger फ़ील्ड जोड़ें मेनिफ़ेस्ट और मेनिफ़ेस्ट दायरे को अपडेट करें, ताकि उनको कंपोज़ करने से जुड़ी ज़रूरी कार्रवाइयों में शामिल किया जा सके.
  2. 'लिखें' ट्रिगर फ़ंक्शन लागू करें, जो 'लिखें' यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके ट्रिगर सक्रिय करता है. कंपोज़ ट्रिगर फ़ंक्शन या तो एक Card ऑब्जेक्ट या Card ऑब्जेक्ट की कैटगरी दिखाते हैं, जिसमें लिखने की कार्रवाई के लिए यूज़र इंटरफ़ेस (यूआई) शामिल होता है.
  3. उपयोगकर्ता के इंटरैक्शन के लिए उपयोगकर्ता के ज़रूरी कॉलबैक फ़ंक्शन लागू करें, ताकि यूज़र इंटरफ़ेस (यूआई) इंटरैक्शन बनाया जा सके. ये फ़ंक्शन, खुद लिखें लिखने की कार्रवाई नहीं हैं (जो सिर्फ़ लिखने के यूज़र इंटरफ़ेस (यूआई) के लिए दिखते हैं); बल्कि ये वे अलग-अलग फ़ंक्शन हैं जो यह तय करते हैं कि कंपोज़िशन के यूज़र इंटरफ़ेस (यूआई) के अलग-अलग एलिमेंट चुने जाने पर क्या होगा. उदाहरण के लिए, किसी बटन वाले यूज़र इंटरफ़ेस (यूआई) कार्ड में आम तौर पर एक जुड़ा हुआ कॉलबैक फ़ंक्शन होता है, जो उपयोगकर्ता के उस बटन पर क्लिक करने पर चलता है. उन विजेट के लिए कॉलबैक फ़ंक्शन जो ड्राफ़्ट मैसेज कॉन्टेंट को अपडेट करते हैं, उन्हें UpdateDraftActionResponse ऑब्जेक्ट दिखाना चाहिए.

ट्रिगर फ़ंक्शन लिखें

ऐड-ऑन's लिखें यूज़र इंटरफ़ेस (यूआई) की तरह ही ऐड-ऑन और मैसेज सेवा यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल किया जाता है.कार्ड सेवाका इस्तेमाल करके कार्ड बनाए जाते हैं और उन्हें विजेट से भरा जाता है.

आपको अपने मेनिफ़ेस्ट में बताए गए gmail.composeTrigger.selectActions[].runFunction को लागू करना होगा. लिखें ट्रिगर फ़ंक्शन को या तो एक Card ऑब्जेक्ट या Card ऑब्जेक्ट की कैटगरी देनी चाहिए जिसमें उस कार्रवाई के लिए लिखें यूज़र इंटरफ़ेस (यूआई) शामिल हो. ये फ़ंक्शन कीवर्ड ट्रिगर करने के फ़ंक्शन से काफ़ी मिलते-जुलते हैं और उन्हें एक ही तरह से कार्ड बनाने चाहिए.

ट्रिगर इवेंट ऑब्जेक्ट लिखें

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

इवेंट ऑब्जेक्ट में जानकारी को व्यवस्थित करने के तरीके के बारे में जानने के लिए, इवेंट ऑब्जेक्ट स्ट्रक्चर देखें. इवेंट ऑब्जेक्ट में शामिल जानकारी को gmail.composeTrigger.draftAccess मेनिफ़ेस्ट फ़ील्ड के मान से आंशिक रूप से कंट्रोल किया जाता है:

  • अगर gmail.composeTrigger.draftAccess मेनिफ़ेस्ट फ़ील्ड NONE है या शामिल नहीं है, तो इवेंट ऑब्जेक्ट में सिर्फ़ कम से कम जानकारी होगी.

  • अगर gmail.composeTrigger.draftAccess METADATA पर सेट है, तो 'लिखें' ट्रिगर फ़ंक्शन को पास किया गया इवेंट ऑब्जेक्ट, ईमेल पाने वाले लोगों की सूचियों से भरा जाता है.

सक्रिय ड्राफ़्ट में सामग्री सम्मिलित करना

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

मौजूदा ड्राफ़्ट ईमेल को आसानी से अपडेट करने के लिए, कार्ड सेवा को इन कक्षाओं के साथ बढ़ाया गया है:

  • ContentType—एक ईनम जो बताता है कि बदले जा सकने वाला एचटीएमएल, नहीं बदले जा सकने वाला एचटीएमएल (जिसे Gmail उपयोगकर्ता बदलाव नहीं कर सकते) या सादा टेक्स्ट कॉन्टेंट जोड़ सकते हैं.
  • UpdateDraftActionResponse—मौजूदा कार्रवाई वाले ईमेल को अपडेट करने वाली कार्रवाई का जवाब दिखाता है.
  • UpdateDraftActionResponseBuilderUpdateDraftActionResponse ऑब्जेक्ट के लिए बिल्डर.
  • UpdateDraftBodyAction—उस कार्रवाई को दिखाता है जो मौजूदा ड्राफ़्ट ईमेल के मुख्य हिस्से को अपडेट करती है.
  • UpdateDraftBodyType—एक ईनम जो बताता है कि शरीर कैसे बदला जाता है.
  • UpdateDraftSubjectAction—एक ऐसी कार्रवाई को दिखाता है जो मौजूदा ड्राफ़्ट के ईमेल के विषय फ़ील्ड को अपडेट करती है.
  • UpdateDraftToRecipientsAction—एक ऐसी कार्रवाई को दिखाता है जो मौजूदा ड्राफ़्ट के ईमेल पाने वाले लोगों को अपडेट करती है.
  • UpdateDraftCcRecipientsAction—एक ऐसी कार्रवाई को दिखाता है जो मौजूदा ड्राफ़्ट के ईमेल की कॉपी पाने वाले लोगों को अपडेट करती है.
  • UpdateDraftBccRecipientsAction—एक ऐसी कार्रवाई दिखाता है जो मौजूदा ड्राफ़्ट ईमेल के गुप्त कॉपी पाने वाले हैं.

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

उदाहरण 1

नीचे दिए गए कोड स्निपेट में, लिखने के लिए ऐसा यूज़र इंटरफ़ेस (यूआई) बनाने का तरीका बताया गया है जो विषय को अपडेट करता है. साथ ही, मौजूदा ईमेल ड्राफ़्ट के 'कॉपी', 'कॉपी', 'गुप्त कॉपी' फ़ील्ड को भी अपडेट करता है.

    /**
     * Compose trigger function that fires when the compose UI is
     * requested. Builds and returns a compose UI for inserting images.
     *
     * @param {event} e The compose trigger event object. Not used in
     *         this example.
     * @return {Card[]}
     */
    function getComposeUI(e) {
      return [buildComposeCard()];
    }

    /**
     * Build a card to display interactive buttons to allow the user to
     * update the subject, and To, Cc, Bcc recipients.
     *
     * @return {Card}
     */
    function buildComposeCard() {

      var card = CardService.newCardBuilder();
      var cardSection = CardService.newCardSection().setHeader('Update email');
      cardSection.addWidget(
          CardService.newTextButton()
              .setText('Update subject')
              .setOnClickAction(CardService.newAction()
                  .setFunctionName('applyUpdateSubjectAction')));
      cardSection.addWidget(
          CardService.newTextButton()
              .setText('Update To recipients')
              .setOnClickAction(CardService.newAction()
                  .setFunctionName('updateToRecipients')));
      cardSection.addWidget(
          CardService.newTextButton()
              .setText('Update Cc recipients')
              .setOnClickAction(CardService.newAction()
                  .setFunctionName('updateCcRecipients')));
      cardSection.addWidget(
          CardService.newTextButton()
              .setText('Update Bcc recipients')
              .setOnClickAction(CardService.newAction()
                  .setFunctionName('updateBccRecipients')));
      return card.addSection(cardSection).build();
    }

    /**
     * Updates the subject field of the current email when the user clicks
     * on "Update subject" in the compose UI.
     *
     * Note: This is not the compose action that builds a compose UI, but
     * rather an action taken when the user interacts with the compose UI.
     *
     * @return {UpdateDraftActionResponse}
     */
    function applyUpdateSubjectAction() {
      // Get the new subject field of the email.
      // This function is not shown in this example.
      var subject = getSubject();
      var response = CardService.newUpdateDraftActionResponseBuilder()
          .setUpdateDraftSubjectAction(CardService.newUpdateDraftSubjectAction()
              .addUpdateSubject(subject))
          .build();
      return response;
    }

    /**
     * Updates the To recipients of the current email when the user clicks
     * on "Update To recipients" in the compose UI.
     *
     * Note: This is not the compose action that builds a compose UI, but
     * rather an action taken when the user interacts with the compose UI.
     *
     * @return {UpdateDraftActionResponse}
     */
    function applyUpdateToRecipientsAction() {
      // Get the new To recipients of the email.
      // This function is not shown in this example.
      var toRecipients = getToRecipients();
      var response = CardService.newUpdateDraftActionResponseBuilder()
          .setUpdateDraftToRecipientsAction(CardService.newUpdateDraftToRecipientsAction()
              .addUpdateToRecipients(toRecipients))
          .build();
      return response;
    }

    /**
     * Updates the Cc recipients  of the current email when the user clicks
     * on "Update Cc recipients" in the compose UI.
     *
     * Note: This is not the compose action that builds a compose UI, but
     * rather an action taken when the user interacts with the compose UI.
     *
     * @return {UpdateDraftActionResponse}
     */
    function applyUpdateCcRecipientsAction() {
      // Get the new Cc recipients of the email.
      // This function is not shown in this example.
      var ccRecipients = getCcRecipients();
      var response = CardService.newUpdateDraftActionResponseBuilder()
          .setUpdateDraftCcRecipientsAction(CardService.newUpdateDraftCcRecipientsAction()
              .addUpdateToRecipients(ccRecipients))
          .build();
      return response;
    }

    /**
     * Updates the Bcc recipients  of the current email when the user clicks
     * on "Update Bcc recipients" in the compose UI.
     *
     * Note: This is not the compose action that builds a compose UI, but
     * rather an action taken when the user interacts with the compose UI.
     *
     * @return {UpdateDraftActionResponse}
     */
    function applyUpdateBccRecipientsAction() {
      // Get the new Bcc recipients of the email.
      // This function is not shown in this example.
      var bccRecipients = getBccRecipients();
      var response = CardService.newUpdateDraftActionResponseBuilder()
          .setUpdateDraftBccRecipientsAction(CardService.newUpdateDraftBccRecipientsAction()
              .addUpdateToRecipients(bccRecipients))
          .build();
      return response;
    }

उदाहरण 2

नीचे दिया गया कोड स्निपेट, लिखने के लिए यूज़र इंटरफ़ेस (यूआई) बनाने का तरीका बताता है, जो मौजूदा ड्राफ़्ट ईमेल में इमेज डालता है.

    /**
     * Compose trigger function that fires when the compose UI is
     * requested. Builds and returns a compose UI for inserting images.
     *
     * @param {event} e The compose trigger event object. Not used in
     *         this example.
     * @return {Card[]}
     */
    function getInsertImageComposeUI(e) {
      return [buildImageComposeCard()];
    }

    /**
     * Build a card to display images from a third-party source.
     *
     * @return {Card}
     */
    function buildImageComposeCard() {
      // Get a short list of image URLs to display in the UI.
      // This function is not shown in this example.
      var imageUrls = getImageUrls();

      var card = CardService.newCardBuilder();
      var cardSection = CardService.newCardSection().setHeader('My Images');
      for (var i = 0; i < imageUrls.length; i++) {
        var imageUrl = imageUrls[i];
        cardSection.addWidget(
            CardService.newImage()
                .setImageUrl(imageUrl)
                .setOnClickAction(CardService.newAction()
                      .setFunctionName('applyInsertImageAction')
                      .setParameters({'url' : imageUrl})));
      }
      return card.addSection(cardSection).build();
    }

    /**
     * Adds an image to the current draft email when the image is clicked
     * in the compose UI. The image is inserted at the current cursor
     * location. If any content of the email draft is currently selected,
     * it is deleted and replaced with the image.
     *
     * Note: This is not the compose action that builds a compose UI, but
     * rather an action taken when the user interacts with the compose UI.
     *
     * @param {event} e The incoming event object.
     * @return {UpdateDraftActionResponse}
     */
    function applyInsertImageAction(e) {
      var imageUrl = e.parameters.url;
      var imageHtmlContent = '<img style=\"display: block\" src=\"'
           + imageUrl + '\"/>';
      var response = CardService.newUpdateDraftActionResponseBuilder()
          .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction()
              .addUpdateContent(
                  imageHtmlContent,
                  CardService.ContentType.MUTABLE_HTML)
              .setUpdateType(
                  CardService.UpdateDraftBodyType.IN_PLACE_INSERT))
          .build();
      return response;
    }