রচনা ক্রিয়া সহ রচনা UI প্রসারিত করা

একজন ব্যবহারকারী যখন Gmail মেসেজ পড়ছেন তখন একটি কার্ড-ভিত্তিক ইন্টারফেস দেওয়ার পাশাপাশি, Google Workspace অ্যাড-অন যা Gmail প্রসারিত করে অন্য ইন্টারফেস প্রদান করতে পারে যখন ব্যবহারকারী নতুন মেসেজ লিখছেন বা বিদ্যমান মেসেজের উত্তর দিচ্ছেন। এটি Google Workspace অ্যাড-অনকে ব্যবহারকারীর জন্য ইমেল রচনা করার কাজটি স্বয়ংক্রিয়ভাবে করতে দেয়।

অ্যাড-অন কম্পোজ UI অ্যাক্সেস করা হচ্ছে

একটি অ্যাড-অনের রচনা UI দেখার দুটি উপায় রয়েছে৷ প্রথম উপায় হল একটি নতুন খসড়া রচনা করা শুরু করা বা অ্যাড-অন ইতিমধ্যে খোলা থাকা অবস্থায় উত্তর দেওয়া। দ্বিতীয় উপায় হল একটি খসড়া রচনা করার সময় অ্যাড-অন শুরু করা।

যেকোনো ক্ষেত্রেই অ্যাড-অনকে সংশ্লিষ্ট কম্পোজ ট্রিগার ফাংশনটি কার্যকর করতে দেয়, অ্যাড-অন ম্যানিফেস্টে সংজ্ঞায়িত করা হয়েছে। কম্পোজ ট্রিগার ফাংশন সেই কম্পোজ অ্যাকশনের জন্য কম্পোজ UI তৈরি করে, যা Gmail তারপর ব্যবহারকারীকে প্রদর্শন করে।

একটি রচনা অ্যাড-অন তৈরি করা

আপনি এই সাধারণ পদক্ষেপগুলি অনুসরণ করে একটি অ্যাড-অনে রচনা কার্যকারিতা যুক্ত করতে পারেন:

  1. অ্যাড-অন স্ক্রিপ্ট প্রজেক্ট ম্যানিফেস্টে gmail.composeTrigger ক্ষেত্র যোগ করুন এবং রচনা ক্রিয়াগুলির জন্য প্রয়োজনীয় অন্তর্ভুক্ত করতে ম্যানিফেস্ট স্কোপগুলি আপডেট করুন৷
  2. একটি রচনা ট্রিগার ফাংশন প্রয়োগ করুন যা একটি রচনা UI তৈরি করে যখন ট্রিগার ফায়ার হয়৷ কম্পোজ ট্রিগার ফাংশনগুলি হয় একটি একক Card অবজেক্ট বা Card অবজেক্টের একটি অ্যারে প্রদান করে যা রচনা কর্মের জন্য কম্পোজ UI অন্তর্ভুক্ত করে।
  3. ব্যবহারকারীর কম্পোজ UI মিথস্ক্রিয়াগুলিতে প্রতিক্রিয়া জানাতে প্রয়োজনীয় সংশ্লিষ্ট কলব্যাক ফাংশনগুলি প্রয়োগ করুন৷ এই ফাংশনগুলি নিজেই কম্পোজ অ্যাকশন নয় (যা শুধুমাত্র কম্পোজ UI দেখায়); বরং, এইগুলি হল স্বতন্ত্র ফাংশন যা কম্পোজ UI এর বিভিন্ন উপাদান নির্বাচন করা হলে কী ঘটবে তা নিয়ন্ত্রণ করে। উদাহরণস্বরূপ, একটি বোতাম ধারণকারী একটি UI কার্ডে সাধারণত একটি যুক্ত কলব্যাক ফাংশন থাকে যা ব্যবহারকারী সেই বোতামটি ক্লিক করলে কার্যকর হয়। উইজেটগুলির জন্য কলব্যাক ফাংশন যা খসড়া বার্তা সামগ্রী আপডেট করে একটি UpdateDraftActionResponse অবজেক্ট ফেরত দেয়।

রচনা ট্রিগার ফাংশন

একটি অ্যাড-অনের কম্পোজ UI অ্যাড-অনের মেসেজ UI-এর মতোই তৈরি করা হয়— কার্ডগুলি তৈরি করতে এবং উইজেটগুলি পূরণ করতে অ্যাপস স্ক্রিপ্ট কার্ড পরিষেবা ব্যবহার করে৷

আপনাকে অবশ্যই gmail.composeTrigger.selectActions[].runFunction বাস্তবায়ন করতে হবে যা আপনি আপনার ম্যানিফেস্টে সংজ্ঞায়িত করেছেন৷ কম্পোজ ট্রিগার ফাংশনটি অবশ্যই একটি একক Card অবজেক্ট বা Card অবজেক্টের একটি অ্যারে দিতে হবে যা সেই ক্রিয়াটির জন্য কম্পোজ UI অন্তর্ভুক্ত করে। এই ফাংশনগুলি প্রাসঙ্গিক ট্রিগার ফাংশনগুলির সাথে খুব মিল এবং একইভাবে কার্ড তৈরি করা উচিত।

ট্রিগার ইভেন্ট অবজেক্ট রচনা করুন

যখন একটি রচনা কর্ম নির্বাচন করা হয়, এটি সংশ্লিষ্ট রচনা ট্রিগার ফাংশন নির্বাহ করে এবং ফাংশনটিকে একটি ইভেন্ট অবজেক্টকে প্যারামিটার হিসাবে পাস করে। ইভেন্ট অবজেক্ট অ্যাড-অন প্রসঙ্গ এবং ট্রিগার ফাংশনে তৈরি করা খসড়া সম্পর্কে তথ্য বহন করতে পারে।

ইভেন্ট অবজেক্টে তথ্য কীভাবে সাজানো হয় তার বিস্তারিত জানার জন্য ইভেন্ট অবজেক্টের গঠন দেখুন। ইভেন্ট অবজেক্টে থাকা তথ্য আংশিকভাবে gmail.composeTrigger.draftAccess ম্যানিফেস্ট ক্ষেত্রের মান দ্বারা নিয়ন্ত্রিত হয়:

  • যদি gmail.composeTrigger.draftAccess ম্যানিফেস্ট ক্ষেত্রটি NONE থাকে বা অন্তর্ভুক্ত না হয়, তবে ইভেন্ট অবজেক্টে শুধুমাত্র ন্যূনতম তথ্য থাকে৷

  • যদি gmail.composeTrigger.draftAccess METADATA তে সেট করা থাকে, তাহলে কম্পোজ ট্রিগার ফাংশনে পাস করা ইভেন্ট অবজেক্টটি কম্পোজ করা ইমেলের প্রাপকদের তালিকা দিয়ে তৈরি করা হয়।

সক্রিয় খসড়া মধ্যে বিষয়বস্তু সন্নিবেশ

সাধারণত একটি Google Workspace অ্যাড-অন কম্পোজ UI ব্যবহারকারীর বিকল্প এবং নিয়ন্ত্রণ প্রদান করে যা একটি বার্তা রচনা করতে সাহায্য করে। এই ব্যবহারের ক্ষেত্রে, ব্যবহারকারী একবার UI-তে নির্বাচন করার পরে অ্যাড-অন নির্বাচনগুলিকে ব্যাখ্যা করে এবং সেই অনুযায়ী বর্তমান কার্যকরী ইমেল খসড়া আপডেট করে।

বর্তমান খসড়া ইমেল আপডেট করা সহজ করার জন্য, কার্ড পরিষেবাটি নিম্নলিখিত ক্লাসগুলির সাথে সম্প্রসারিত করা হয়েছে:

  • ContentType — একটি enum যা পরিবর্তিত HTML, অপরিবর্তনীয় HTML (যা Gmail ব্যবহারকারীরা সম্পাদনা করতে পারে না), বা প্লেইন টেক্সট কন্টেন্ট যোগ করতে হবে কিনা তা নির্ধারণ করে।
  • UpdateDraftActionResponse — বর্তমান খসড়া ইমেল আপডেট করে এমন একটি কর্মের প্রতিক্রিয়া উপস্থাপন করে।
  • UpdateDraftActionResponseBuilder — UpdateDraftActionResponse অবজেক্টের জন্য একটি নির্মাতা।
  • UpdateDraftBodyAction — এমন একটি ক্রিয়াকে প্রতিনিধিত্ব করে যা বর্তমান খসড়া ইমেলের মূল অংশকে আপডেট করে।
  • UpdateDraftBodyType — একটি enum যা সংজ্ঞায়িত করে কিভাবে বডি পরিবর্তন করা হয়।
  • UpdateDraftSubjectAction — এমন একটি ক্রিয়াকে প্রতিনিধিত্ব করে যা বর্তমান খসড়া ইমেলের বিষয় ক্ষেত্র আপডেট করে।
  • UpdateDraftToRecipientsAction — এমন একটি ক্রিয়াকে প্রতিনিধিত্ব করে যা বর্তমান খসড়া ইমেলের প্রাপকদের আপডেট করে।
  • UpdateDraftCcRecipientsAction — এমন একটি ক্রিয়াকে প্রতিনিধিত্ব করে যা বর্তমান খসড়া ইমেলের Cc প্রাপকদের আপডেট করে।
  • UpdateDraftBccRecipientsAction — এমন একটি ক্রিয়াকে প্রতিনিধিত্ব করে যা বর্তমান খসড়া ইমেলের Bcc প্রাপকদের আপডেট করে।

সাধারণত একটি অ্যাড-অন কম্পোজ UI-তে একটি 'সংরক্ষণ করুন' বা 'সন্নিবেশ' উইজেট থাকে যা ব্যবহারকারী UI-তে নির্বাচন করা শেষ করে ইঙ্গিত করতে ক্লিক করতে পারেন এবং চান যে তারা যে ইমেল রচনা করছেন তাতে তাদের পছন্দ যোগ করা হোক। এই ইন্টারঅ্যাক্টিভিটি যোগ করার জন্য, উইজেটটিতে একটি যুক্ত Action অবজেক্ট থাকা উচিত যা অ্যাড-অনকে একটি নির্দিষ্ট কলব্যাক ফাংশন চালানোর নির্দেশ দেয় যখন উইজেটটি ক্লিক করা হয়। আপনি এই কলব্যাক ফাংশন বাস্তবায়ন করতে হবে. প্রতিটি কলব্যাক ফাংশন একটি নির্মিত UpdateDraftActionResponse অবজেক্ট ফেরত দেবে যা বর্তমান খসড়া ইমেলে করা পরিবর্তনের বিবরণ দেয়।

উদাহরণ 1

নিম্নলিখিত কোড স্নিপেট দেখায় যে কীভাবে একটি রচনা UI তৈরি করতে হয় যা বিষয় আপডেট করে এবং বর্তমান ইমেল খসড়ার প্রতি, সিসি, বিসিসি প্রাপকদের।

    /**
     * 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

নিম্নলিখিত কোড স্নিপেট দেখায় কিভাবে একটি রচনা UI তৈরি করতে হয় যা বর্তমান খসড়া ইমেলে চিত্রগুলি সন্নিবেশিত করে৷

    /**
     * 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;
    }