همگام سازی تغییرات کنفرانس تقویم

کاربران می‌توانند رویدادهای تقویم گوگل خود را آزادانه به‌روزرسانی یا حذف کنند. اگر کاربری پس از ایجاد کنفرانس، رویدادی را به‌روزرسانی کند، افزونه شما ممکن است نیاز داشته باشد با به‌روزرسانی داده‌های کنفرانس به این تغییر پاسخ دهد. اگر سیستم کنفرانس شخص ثالث شما به پیگیری داده‌های رویداد وابسته است، عدم به‌روزرسانی کنفرانس در مورد تغییر رویداد می‌تواند کنفرانس را غیرقابل استفاده کند و منجر به تجربه کاربری ضعیف شود.

فرآیند به‌روزرسانی داده‌های کنفرانس با تغییرات در رویداد تقویم گوگل، همگام‌سازی نامیده می‌شود. شما می‌توانید تغییرات رویداد را با ایجاد یک تریگر قابل نصب Apps Script که هر زمان رویدادها در یک تقویم مشخص تغییر می‌کنند، اجرا می‌شود، همگام‌سازی کنید. متأسفانه، تریگر گزارش نمی‌دهد که کدام رویدادها تغییر کرده‌اند و نمی‌توانید آن را فقط به رویدادهایی با کنفرانس‌هایی که ایجاد کرده‌اید محدود کنید. در عوض، باید لیستی از تمام تغییرات ایجاد شده در یک تقویم از آخرین همگام‌سازی را درخواست کنید، لیست رویدادها را فیلتر کنید و بر اساس آن به‌روزرسانی‌ها را انجام دهید.

روش کلی همگام‌سازی به شرح زیر است:

  1. اولین باری که کاربر یک کنفرانس ایجاد می‌کند، فرآیند همگام‌سازی آغاز می‌شود.
  2. هر زمان که کاربر یکی از رویدادهای تقویم خود را ایجاد، به‌روزرسانی یا حذف می‌کند، تریگر یک تابع تریگر را در پروژه افزونه شما اجرا می‌کند.
  3. تابع تریگر، مجموعه تغییرات رویداد را از آخرین همگام‌سازی بررسی می‌کند و تعیین می‌کند که آیا نیازی به به‌روزرسانی یک کنفرانس شخص ثالث مرتبط وجود دارد یا خیر.
  4. هرگونه به‌روزرسانی مورد نیاز برای کنفرانس‌ها با درخواست از APIهای شخص ثالث انجام می‌شود.
  5. یک توکن همگام‌سازی جدید ذخیره می‌شود تا اجرای بعدی تریگر فقط نیاز به بررسی جدیدترین تغییرات تقویم داشته باشد.

همگام‌سازی اولیه

زمانی که افزونه با موفقیت یک کنفرانس در یک سیستم شخص ثالث ایجاد کرد، باید یک تریگر قابل نصب ایجاد کند که به تغییرات رویداد در این تقویم پاسخ دهد، البته اگر تریگر از قبل وجود نداشته باشد.

پس از ایجاد تریگر، مقداردهی اولیه باید با ایجاد توکن همگام‌سازی اولیه به پایان برسد. این کار با اجرای مستقیم تابع تریگر انجام می‌شود.

یک تریگر تقویم ایجاد کنید

برای همگام‌سازی، افزونه شما باید تشخیص دهد که چه زمانی یک رویداد تقویم که کنفرانس پیوست‌شده‌ای دارد، تغییر می‌کند. این کار با ایجاد یک تریگر قابل نصب EventUpdated انجام می‌شود. افزونه شما فقط برای هر تقویم به یک تریگر نیاز دارد و می‌تواند آنها را به صورت برنامه‌نویسی ایجاد کند.

زمان مناسب برای ایجاد یک تریگر زمانی است که کاربر اولین کنفرانس خود را ایجاد می‌کند، زیرا در آن زمان کاربر شروع به استفاده از افزونه می‌کند. پس از ایجاد یک کنفرانس و تأیید عدم وجود خطا، افزونه شما باید بررسی کند که آیا تریگر برای این کاربر وجود دارد یا خیر و در صورت عدم وجود، آن را ایجاد کند.

پیاده‌سازی یک تابع ماشه همگام‌سازی

توابع تریگر زمانی اجرا می‌شوند که Apps Script شرایطی را تشخیص دهد که باعث فعال شدن تریگر می‌شود. EventUpdated Calendar زمانی فعال می‌شود که کاربر هر رویدادی را در یک تقویم مشخص ایجاد، اصلاح یا حذف کند.

شما باید تابع تریگر مورد استفاده افزونه خود را پیاده‌سازی کنید. این تابع تریگر باید موارد زیر را انجام دهد:

  1. یک سرویس پیشرفته تقویم Calendar.Events.list() ایجاد کنید و با استفاده از syncToken لیستی از رویدادهایی که از آخرین همگام‌سازی تغییر کرده‌اند را بازیابی کنید. با استفاده از sync token تعداد رویدادهایی که افزونه شما باید بررسی کند را کاهش می‌دهید.

    وقتی تابع تریگر بدون توکن همگام‌سازی معتبر اجرا می‌شود، به حالت همگام‌سازی کامل برمی‌گردد. همگام‌سازی‌های کامل صرفاً تلاش می‌کنند تا تمام رویدادها را در یک بازه زمانی مشخص بازیابی کنند تا یک توکن همگام‌سازی معتبر جدید تولید کنند.

  2. هر رویداد اصلاح‌شده بررسی می‌شود تا مشخص شود که آیا کنفرانس شخص ثالثی مرتبط با آن وجود دارد یا خیر.
  3. اگر رویدادی دارای کنفرانس باشد، بررسی می‌شود که چه چیزی تغییر کرده است. بسته به تغییر، ممکن است اصلاح کنفرانس مرتبط ضروری باشد. به عنوان مثال، اگر رویدادی حذف شده باشد، افزونه احتمالاً باید کنفرانس را نیز حذف کند.
  4. هرگونه تغییر مورد نیاز در کنفرانس با برقراری تماس‌های API به سیستم شخص ثالث انجام می‌شود.
  5. پس از انجام تمام تغییرات لازم، nextSyncToken برگردانده شده توسط متد Calendar.Events.list() را ذخیره کنید. این توکن همگام‌سازی در آخرین صفحه نتایج برگردانده شده توسط فراخوانی Calendar.Events.list() یافت می‌شود.

به‌روزرسانی رویداد تقویم گوگل

در برخی موارد، ممکن است بخواهید هنگام انجام همگام‌سازی، رویداد تقویم گوگل را به‌روزرسانی کنید. اگر تصمیم به انجام این کار دارید، به‌روزرسانی رویداد را با درخواست سرویس پیشرفته تقویم گوگل مناسب انجام دهید. حتماً از به‌روزرسانی مشروط با هدر If-Match استفاده کنید. این کار مانع از آن می‌شود که تغییرات شما سهواً روی تغییرات همزمان انجام شده توسط کاربر در یک کلاینت دیگر بازنویسی شوند.

مثال

مثال زیر نشان می‌دهد که چگونه می‌توانید همگام‌سازی را برای رویدادهای تقویم و کنفرانس‌های مرتبط با آنها تنظیم کنید.

/**
 *  Initializes syncing of conference data by creating a sync trigger and
 *  sync token if either does not exist yet.
 *
 *  @param {String} calendarId The ID of the Google Calendar.
 */
function initializeSyncing(calendarId) {
  // Create a syncing trigger if it doesn't exist yet.
  createSyncTrigger(calendarId);

  // Perform an event sync to create the initial sync token.
  syncEvents({'calendarId': calendarId});
}

/**
 *  Creates a sync trigger if it does not exist yet.
 *
 *  @param {String} calendarId The ID of the Google Calendar.
 */
function createSyncTrigger(calendarId) {
  // Check to see if the trigger already exists; if does, return.
  var allTriggers = ScriptApp.getProjectTriggers();
  for (var i = 0; i < allTriggers.length; i++) {
    var trigger = allTriggers[i];
    if (trigger.getTriggerSourceId() == calendarId) {
      return;
    }
  }

  // Trigger does not exist, so create it. The trigger calls the
  // 'syncEvents()' trigger function when it fires.
  var trigger = ScriptApp.newTrigger('syncEvents')
      .forUserCalendar(calendarId)
      .onEventUpdated()
      .create();
}

/**
 *  Sync events for the given calendar; this is the syncing trigger
 *  function. If a sync token already exists, this retrieves all events
 *  that have been modified since the last sync, then checks each to see
 *  if an associated conference needs to be updated and makes any required
 *  changes. If the sync token does not exist or is invalid, this
 *  retrieves future events modified in the last 24 hours instead. In
 *  either case, a new sync token is created and stored.
 *
 *  @param {Object} e If called by a event updated trigger, this object
 *      contains the Google Calendar ID, authorization mode, and
 *      calling trigger ID. Only the calendar ID is actually used here,
 *      however.
 */
function syncEvents(e) {
  var calendarId = e.calendarId;
  var properties = PropertiesService.getUserProperties();
  var syncToken = properties.getProperty('syncToken');

  var options;
  if (syncToken) {
    // There's an existing sync token, so configure the following event
    // retrieval request to only get events that have been modified
    // since the last sync.
    options = {
      syncToken: syncToken
    };
  } else {
    // No sync token, so configure to do a 'full' sync instead. In this
    // example only recently updated events are retrieved in a full sync.
    // A larger time window can be examined during a full sync, but this
    // slows down the script execution. Consider the trade-offs while
    // designing your add-on.
    var now = new Date();
    var yesterday = new Date();
    yesterday.setDate(now.getDate() - 1);
    options = {
      timeMin: now.toISOString(),          // Events that start after now...
      updatedMin: yesterday.toISOString(), // ...and were modified recently
      maxResults: 50,   // Max. number of results per page of responses
      orderBy: 'updated'
    }
  }

  // Examine the list of updated events since last sync (or all events
  // modified after yesterday if the sync token is missing or invalid), and
  // update any associated conferences as required.
  var events;
  var pageToken;
  do {
    try {
      options.pageToken = pageToken;
      events = Calendar.Events.list(calendarId, options);
    } catch (err) {
      // Check to see if the sync token was invalidated by the server;
      // if so, perform a full sync instead.
      if (err.message ===
            "Sync token is no longer valid, a full sync is required.") {
        properties.deleteProperty('syncToken');
        syncEvents(e);
        return;
      } else {
        throw new Error(err.message);
      }
    }

    // Read through the list of returned events looking for conferences
    // to update.
    if (events.items && events.items.length > 0) {
      for (var i = 0; i < events.items.length; i++) {
         var calEvent = events.items[i];
         // Check to see if there is a record of this event has a
         // conference that needs updating.
         if (eventHasConference(calEvent)) {
           updateConference(calEvent, calEvent.conferenceData.conferenceId);
         }
      }
    }

    pageToken = events.nextPageToken;
  } while (pageToken);

  // Record the new sync token.
  if (events.nextSyncToken) {
    properties.setProperty('syncToken', events.nextSyncToken);
  }
}

/**
 *  Returns true if the specified event has an associated conference
 *  of the type managed by this add-on; retuns false otherwise.
 *
 *  @param {Object} calEvent The Google Calendar event object, as defined by
 *      the Calendar API.
 *  @return {boolean}
 */
function eventHasConference(calEvent) {
  var name = calEvent.conferenceData.conferenceSolution.name || null;

  // This version checks if the conference data solution name matches the
  // one of the solution names used by the add-on. Alternatively you could
  // check the solution's entry point URIs or other solution-specific
  // information.
  if (name) {
    if (name === "My Web Conference" ||
        name === "My Recorded Web Conference") {
      return true;
    }
  }
  return false;
}

/**
 *  Update a conference based on new Google Calendar event information.
 *  The exact implementation of this function is highly dependant on the
 *  details of the third-party conferencing system, so only a rough outline
 *  is shown here.
 *
 *  @param {Object} calEvent The Google Calendar event object, as defined by
 *      the Calendar API.
 *  @param {String} conferenceId The ID used to identify the conference on
 *      the third-party conferencing system.
 */
function updateConference(calEvent, conferenceId) {
  // Check edge case: the event was cancelled
  if (calEvent.status === 'cancelled' || eventHasConference(calEvent)) {
    // Use the third-party API to delete the conference too.


  } else {
    // Extract any necessary information from the event object, then
    // make the appropriate third-party API requests to update the
    // conference with that information.

  }
}