তৃতীয় পক্ষের সম্মেলন তৈরি করা

আপনার স্ক্রিপ্ট প্রজেক্ট ম্যানিফেস্টে সংজ্ঞায়িত প্রতিটি কনফারেন্স সলিউশনের সাথে একটি যুক্ত onCreateFunction থাকে। যখনই কোনও ব্যবহারকারী সেই কনফারেন্স সলিউশনটি কোনও ইভেন্ট নির্বাচন করার চেষ্টা করেন তখন অ্যাড-অনটি এই ফাংশনটিকে একটি কনফারেন্স তৈরি করতে বলে।

আপনার অ্যাড-অন ম্যানিফেস্টে বর্ণিত প্রতিটি onCreateFunction বাস্তবায়ন করতে হবে। সাধারণভাবে, এই ফাংশনগুলিকে নিম্নলিখিত কাজগুলি করতে হবে:

  1. কনফারেন্স তৈরি করার জন্য তৃতীয় পক্ষের কনফারেন্সিং সিস্টেমের প্রয়োজনীয় যেকোনো Google ক্যালেন্ডার ইভেন্ট তথ্য, যেমন ইভেন্ট আইডি বা অংশগ্রহণকারীদের তালিকা, পুনরুদ্ধার করুন।
  2. তৃতীয় পক্ষের কনফারেন্সিং পরিষেবার সাথে সংযোগ করুন এবং Google ক্যালেন্ডার ইভেন্ট তথ্য ব্যবহার করে সেখানে একটি নতুন কনফারেন্স তৈরি করুন।
  3. যদি কোনও কারণে কনফারেন্স তৈরির অনুরোধ ব্যর্থ হয়, তাহলে ত্রুটির তথ্য ব্যবহার করে ConferenceError ধারণকারী একটি ConferenceData অবজেক্ট তৈরি করুন এবং ফেরত দিন। অন্যথায়, পরবর্তী পদক্ষেপগুলি সম্পূর্ণ করুন।
    1. কনফারেন্স সিঙ্কিং শুরু করুন।
    2. তৃতীয় পক্ষের কনফারেন্সিং পরিষেবা থেকে প্রাপ্ত তথ্য ব্যবহার করে একটি নতুন ConferenceData অবজেক্ট তৈরি করুন এবং ফেরত দিন।

ইভেন্টের তথ্য পুনরুদ্ধার করা হচ্ছে

একটি তৃতীয় পক্ষের সম্মেলন তৈরি করতে সংশ্লিষ্ট Google ক্যালেন্ডার ইভেন্ট সম্পর্কে কিছু তথ্য প্রয়োজন। প্রয়োজনীয় সঠিক ইভেন্ট তথ্য বিভিন্ন তৃতীয় পক্ষের সম্মেলন সিস্টেমের মধ্যে পরিবর্তিত হয়, তবে প্রায়শই এর মধ্যে ইভেন্ট শুরুর সময়, শেষের সময়, সারাংশ, অংশগ্রহণকারীদের তালিকা এবং আইডি অন্তর্ভুক্ত থাকে।

যখন কল করা হয়, তখন আপনার সংজ্ঞায়িত প্রতিটি onCreateFunction একটি আর্গুমেন্ট পাস করে যাতে ক্যালেন্ডার এবং ইভেন্ট আইডি থাকে। আপনি গুগল ক্যালেন্ডার অ্যাডভান্সড পরিষেবা ব্যবহার করে সম্পূর্ণ ইভেন্ট তথ্য পুনরুদ্ধার করতে এই আইডিগুলি ব্যবহার করতে পারেন।

কোনও ইভেন্টের অস্তিত্বের আগেই গুগল ক্যালেন্ডারের পক্ষে কনফারেন্সের বিবরণ যোগ করা সম্ভব। এই ধরনের ক্ষেত্রে, গুগল ক্যালেন্ডার onCreateFunction কে একটি বৈধ eventId পাস করে, কিন্তু Calendar.Events.get() এ পরবর্তী কলের ফলে একটি ত্রুটির প্রতিক্রিয়া দেখা দিতে পারে যে ইভেন্টটি বিদ্যমান নেই। এই ক্ষেত্রে, প্লেসহোল্ডার ডেটা ব্যবহার করে তৃতীয় পক্ষের কনফারেন্স তৈরি করা ভাল; পরবর্তী সময়ে ইভেন্টটি সিঙ্ক করার সময় এই ডেটা প্রতিস্থাপন করা হয়।

তৃতীয় পক্ষের সম্মেলন তৈরি করা হচ্ছে

onCreateFunction প্রয়োজনীয় ইভেন্ট ডেটা পুনরুদ্ধার করার পরে, কনফারেন্স তৈরি করার জন্য এটিকে তৃতীয় পক্ষের কনফারেন্সিং সিস্টেমের সাথে সংযুক্ত করতে হবে। সাধারণত তৃতীয় পক্ষের কনফারেন্সিং সিস্টেম দ্বারা সমর্থিত API অনুরোধগুলি করে এটি সম্পন্ন করা হয়। কনফারেন্স তৈরি করতে আপনি কোন API অনুরোধগুলি ব্যবহার করতে পারেন তা নির্ধারণ করতে আপনার তৃতীয় পক্ষের কনফারেন্সিং সমাধানের ডকুমেন্টেশন পরীক্ষা করুন।

অ্যাপস স্ক্রিপ্টে, বহিরাগত API অনুরোধগুলি পরিচালনা করার সবচেয়ে সহজ উপায় হল অ্যাপস স্ক্রিপ্টের জন্য OAuth2 বা অ্যাপস স্ক্রিপ্ট ওপেন-সোর্স লাইব্রেরির জন্য OAuth1 ব্যবহার করা। আপনি UrlFetch পরিষেবা ব্যবহার করে বহিরাগত API গুলির সাথে সংযোগ স্থাপন করতে পারেন, তবে এর জন্য আপনাকে অনুমোদনের বিবরণ স্পষ্টভাবে পরিচালনা করতে হবে।

কনফারেন্স তৈরির অনুরোধ করার পর, নতুন কনফারেন্সের বিবরণ পুনরুদ্ধারের জন্য আপনাকে অতিরিক্ত অনুরোধ করতে হতে পারে।

কনফারেন্স সিঙ্কিং শুরু করুন

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

কনফারেন্স তৈরির পরে সিঙ্কিং সেট আপ করার বিশদ বিবরণের জন্য সিঙ্কিং ক্যালেন্ডার পরিবর্তনগুলি দেখুন।

একটি সম্মেলনের তথ্য প্রতিক্রিয়া তৈরি করা

তৃতীয় পক্ষের পরিষেবা থেকে ফেরত আসা কনফারেন্স তথ্য ব্যবহার করে, onCreateFunction কে অবশ্যই একটি ConferenceData অবজেক্ট তৈরি করে ফেরত পাঠাতে হবে; কনফারেন্স ডেটা বিভাগটি এই অবজেক্টের বিষয়বস্তু বর্ণনা করে। Google Calendar এই তথ্য ব্যবহার করে কনফারেন্স শুরু হওয়ার পরে ব্যবহারকারীদের সেখানে নিয়ে যায়।

একটি ConferenceData অবজেক্ট তৈরি করার সময়, মনে রাখবেন যে ক্ষেত্রের দৈর্ঘ্য, এন্ট্রি পয়েন্ট URI-এর ফর্ম্যাট এবং এন্ট্রি পয়েন্টের অনুমোদিত সংমিশ্রণের কিছু সীমাবদ্ধতা রয়েছে। উদাহরণস্বরূপ, একটি ConferenceData তে সর্বাধিক একটি VIDEO এন্ট্রি পয়েন্ট থাকতে পারে। এই সীমাবদ্ধতাগুলি সংশ্লিষ্ট conferenceData ক্ষেত্রের জন্য Calendar API Event](/workspace/calendar/v3/reference/events) এ বর্ণিত সীমাবদ্ধতার সাথে সমান, যদিও সেখানে বর্ণিত সমস্ত API ইভেন্ট ক্ষেত্র Apps Script-এ উপলব্ধ নয়।

ত্রুটি পরিচালনা

কিছু ক্ষেত্রে তৃতীয় পক্ষের কনফারেন্সিং সিস্টেমের ত্রুটির কারণে কনফারেন্স তৈরি সম্পূর্ণ করা যায় না। এই ক্ষেত্রে আপনার অ্যাড-অনটি ConferenceError বিবরণ সম্বলিত একটি ConferenceData অবজেক্ট তৈরি করে এবং ফেরত দিয়ে ত্রুটির অবস্থাটি দৃঢ়ভাবে পরিচালনা করবে, যাতে Google Calendar সেই অনুযায়ী কাজ করতে পারে।

কোনও ত্রুটি রিপোর্ট করার জন্য ConferenceData অবজেক্ট তৈরি করার সময়, ConferenceError অবজেক্ট ছাড়া অন্য কোনও ConferenceData উপাদান অন্তর্ভুক্ত করার প্রয়োজন নেই। ConferenceErrors এ একটি ConferenceErrorType , একটি ত্রুটি বার্তা থাকতে পারে এবং প্রমাণীকরণের ক্ষেত্রে একটি URL থাকে যা ব্যবহারকারীদের তৃতীয়-পক্ষের কনফারেন্সিং সিস্টেমে লগ ইন করতে দেয়।

উদাহরণ

নিচে একটি onCreateFunction এর উদাহরণ দেওয়া হল (মনে রাখবেন যে ফাংশনের নাম যেকোনো হতে পারে; আপনাকে কেবল আপনার অ্যাড-অন প্রজেক্ট ম্যানিফেস্টে এটি সংজ্ঞায়িত করতে হবে)।

create3rdPartyConference() ফাংশনটি তৃতীয় পক্ষের সিস্টেমের সাথে যোগাযোগ করে সেখানে কনফারেন্স তৈরি করে এবং getAuthenticationUrl() ফাংশনটি একটি তৃতীয় পক্ষের সিস্টেম প্রমাণীকরণ URL তৈরি করে। এগুলি এখানে সম্পূর্ণরূপে প্রয়োগ করা হয় না, কারণ এগুলি তৃতীয় পক্ষের সিস্টেমের বিবরণের উপর অত্যন্ত নির্ভরশীল।

initializeSyncing() ফাংশনটি এখানে দেখানো হয়নি; এটি সিঙ্ক করার জন্য প্রয়োজনীয় যেকোনো প্রাথমিক কাজ পরিচালনা করে। বিস্তারিত জানার জন্য সিঙ্ক ক্যালেন্ডার পরিবর্তনগুলি দেখুন।

/**
 *  Creates a conference, then builds and returns a ConferenceData object
 *  with the corresponding conference information. This method is called
 *  when a user selects a conference solution defined by the add-on that
 *  uses this function as its 'onCreateFunction' in the add-on manifest.
 *
 *  @param {Object} arg The default argument passed to a 'onCreateFunction';
 *      it carries information about the Google Calendar event.
 *  @return {ConferenceData}
 */
function createConference(arg) {
  const eventData = arg.eventData;
  const calendarId = eventData.calendarId;
  const eventId = eventData.eventId;

  // Retrieve the Calendar event information using the Calendar
  // Advanced service.
  var calendarEvent;
  try {
    calendarEvent = Calendar.Events.get(calendarId, eventId);
  } catch (err) {
    // The calendar event does not exist just yet; just proceed with the
    // given event ID and allow the event details to sync later.
    console.log(err);
    calendarEvent = {
      id: eventId,
    };
  }

  // Create a conference on the third-party service and return the
  // conference data or errors in a custom JSON object.
  var conferenceInfo = create3rdPartyConference(calendarEvent);

  // Build and return a ConferenceData object, either with conference or
  // error information.
  var dataBuilder = ConferenceDataService.newConferenceDataBuilder();

  if (!conferenceInfo.error) {
    // No error, so build the ConferenceData object from the
    // returned conference info.

    var phoneEntryPoint = ConferenceDataService.newEntryPoint()
        .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
        .setUri('tel:+' + conferenceInfo.phoneNumber)
        .setPin(conferenceInfo.phonePin);

    var adminEmailParameter = ConferenceDataService.newConferenceParameter()
        .setKey('adminEmail')
        .setValue(conferenceInfo.adminEmail);

    dataBuilder.setConferenceId(conferenceInfo.id)
        .addEntryPoint(phoneEntryPoint)
        .addConferenceParameter(adminEmailParameter)
        .setNotes(conferenceInfo.conferenceLegalNotice);

    if (conferenceInfo.videoUri) {
      var videoEntryPoint = ConferenceDataService.newEntryPoint()
          .setEntryPointType(ConferenceDataService.EntryPointType.VIDEO)
          .setUri(conferenceInfo.videoUri)
          .setPasscode(conferenceInfo.videoPasscode);
      dataBuilder.addEntryPoint(videoEntryPoint);
    }

    // Since the conference creation request succeeded, make sure that
    // syncing has been enabled.
    initializeSyncing(calendarId, eventId, conferenceInfo.id);

  } else if (conferenceInfo.error === 'AUTH') {
    // Authenentication error. Implement a function to build the correct
    // authenication URL for the third-party conferencing system.
    var authenticationUrl = getAuthenticationUrl();
    var error = ConferenceDataService.newConferenceError()
        .setConferenceErrorType(
            ConferenceDataService.ConferenceErrorType.AUTHENTICATION)
        .setAuthenticationUrl(authenticationUrl);
    dataBuilder.setError(error);

  } else {
    // Other error type;
    var error = ConferenceDataService.newConferenceError()
        .setConferenceErrorType(
            ConferenceDataService.ConferenceErrorType.TEMPORARY);
    dataBuilder.setError(error);
  }

  // Don't forget to build the ConferenceData object.
  return dataBuilder.build();
}


/**
 *  Contact the third-party conferencing system to create a conference there,
 *  using the provided calendar event information. Collects and retuns the
 *  conference data returned by the third-party system in a custom JSON object
 *  with the following fields:
 *
 *    data.adminEmail - the conference administrator's email
 *    data.conferenceLegalNotice - the conference legal notice text
 *    data.error - Only present if there was an error during
 *         conference creation. Equal to 'AUTH' if the add-on user needs to
 *         authorize on the third-party system.
 *    data.id - the conference ID
 *    data.phoneNumber - the conference phone entry point phone number
 *    data.phonePin - the conference phone entry point PIN
 *    data.videoPasscode - the conference video entry point passcode
 *    data.videoUri - the conference video entry point URI
 *
 *  The above fields are specific to this example; which conference information
 *  your add-on needs is dependent on the third-party conferencing system
 *  requirements.
 *
 * @param {Object} calendarEvent A Calendar Event resource object returned by
 *     the Google Calendar API.
 * @return {Object}
 */
function create3rdPartyConference(calendarEvent) {
  var data = {};

  // Implementation details dependent on the third-party system API.
  // Typically one or more API calls are made to create the conference and
  // acquire its relevant data, which is then put in to the returned JSON
  // object.

  return data;
}

/**
 *  Return the URL used to authenticate the user with the third-party
 *  conferencing system.
 *
 *  @return {String}
 */
function getAuthenticationUrl() {
  var url;
  // Implementation details dependent on the third-party system.

  return url;
}