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

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

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

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

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

همگام سازی را آغاز کنید

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

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

یک راه‌انداز تقویم ایجاد کنید

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

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

یک تابع ماشه همگام سازی را اجرا کنید

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

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

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

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

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

در حال به‌روزرسانی رویداد Google Calendar

در برخی موارد ممکن است بخواهید هنگام انجام همگام‌سازی رویداد Google Calendar را به‌روزرسانی کنید. اگر این کار را انتخاب کردید، رویداد را با درخواست سرویس پیشرفته Google Calendar به‌روزرسانی کنید. حتماً از به‌روزرسانی شرطی با هدر 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.

  }
}