جارٍ مزامنة تغييرات مؤتمر التقويم

المحتوى

يمكن للمستخدمين تعديل أحداث "تقويم Google" أو حذفها بدون أي قيود. إذا حدّث المستخدم حدثًا بعد إنشاء مؤتمر له، فقد تحتاج الإضافة إلى الاستجابة للتغيير عن طريق تحديث بيانات المؤتمر. إذا كان نظام مكالمات الفيديو التابع لجهة خارجية يعتمد على تتبُّع بيانات الفعالية، قد يؤدي عدم تعديل المؤتمر في أي تغيير في الحدث إلى جعل المؤتمر غير قابل للاستخدام وإلى تجربة سيئة للمستخدم.

وتُعرف عملية تعديل بيانات مكالمات الفيديو باستمرار من خلال إجراء تغييرات على حدث "تقويم Google" باسم المزامنة. يمكنك مزامنة تغييرات الأحداث من خلال إنشاء مشغّل قابل للتثبيت لبرمجة التطبيقات، ويتم تنشيطه كلما تغيّرت الأحداث في تقويم معيّن. للأسف، لا يبلغ العامل المشغِّل الأحداث التي تغيرت ولا يمكنك حصره بالأحداث التي تتضمن مؤتمرات أنشأتها فقط. بدلاً من ذلك، يجب عليك طلب قائمة بجميع التغييرات التي تم إجراؤها على التقويم منذ آخر مزامنة، وتصفية قائمة الأحداث، وإجراء التحديثات وفقًا لذلك.

في ما يلي إجراء المزامنة العام:

  1. في المرة الأولى التي ينشئ فيها المستخدم مكالمة فيديو، يتم إعداد عملية المزامنة.
  2. عندما ينشئ المستخدم أحد أحداث "تقويم Google" أو يعدّله أو يحذفه، ينفّذ المشغّل دالة مشغّل في مشروع الإضافة.
  3. تفحص دالة المشغّل مجموعة من تغييرات الأحداث منذ آخر مزامنة وتحدّد ما إذا كان أي منها يتطلب تحديث مؤتمر مرتبط تابع لجهة خارجية.
  4. ويتم إجراء أي تعديلات مطلوبة على المؤتمرات من خلال تقديم طلبات واجهة برمجة تطبيقات تابعة لجهات خارجية.
  5. يتم تخزين رمز مميز جديد للمزامنة بحيث لا يحتاج تنفيذ المشغِّل التالي إلا إلى فحص أحدث التغييرات التي تم إجراؤها على التقويم.

تهيئة المزامنة

بعد إنشاء الإضافة لاجتماع فيديو بنجاح على نظام تابع لجهة خارجية، من المفترض أن تُنشئ الإضافة مشغّلًا قابلاً للتثبيت يستجيب لتغييرات الأحداث في هذا التقويم، إذا لم يكن المُشغِّل متاحًا من قبل.

بعد إنشاء المشغل، ينبغي أن تنتهي التهيئة بإنشاء الرمز المميز للمزامنة الأولي. يتم ذلك عن طريق تنفيذ دالة المشغل مباشرةً.

إنشاء مشغِّل التقويم

للمزامنة، يجب أن ترصد الإضافة وقت إجراء تغيير على حدث "تقويم Google" يتضمّن مؤتمرًا مرفقًا. ويتم تحقيق ذلك من خلال إنشاء مشغِّل EventUpdated قابل للتثبيت. تحتاج الإضافة إلى مشغّل واحد فقط لكل تقويم، ويمكنها إنشاؤها آليًا.

الوقت المناسب لإنشاء عامل مشغِّل هو عندما ينشئ المستخدم مكالمة الفيديو الأولى له، لأنه في تلك المرحلة يبدأ المستخدم في استخدام الإضافة. بعد إنشاء مكالمة فيديو والتحقق من عدم وجود خطأ، يجب أن تتحقق الإضافة لمعرفة ما إذا كان المشغل موجودًا لهذا المستخدم وإذا لم يكن قيد الإنشاء.

تنفيذ وظيفة مشغّل المزامنة

يتم تنفيذ وظائف المشغِّل عندما ترصد "برمجة التطبيقات" حالة تؤدي إلى تنشيط العامل المشغِّل. يتم تنشيط عوامل تشغيل "تقويم Google" على EventUpdated عندما ينشئ المستخدم أي حدث في تقويم محدّد أو يعدّله أو يحذفه.

يجب تنفيذ دالة التشغيل التي تستخدمها الإضافة. يجب أن تقوم دالة المشغل هذه بما يلي:

  1. يمكنك إجراء استدعاء Calendar.Events.list() لخدمة "تقويم Google" المتقدمة باستخدام syncToken لاسترداد قائمة الأحداث التي تم تغييرها منذ آخر مزامنة. باستخدام رمز مميز للمزامنة، يمكنك تقليل عدد الأحداث التي يجب أن تفحصها الإضافة.

    عند تنفيذ دالة المشغّل بدون رمز مميّز صالح للمزامنة، يتم إيقافها إلى مزامنة كاملة. تحاول عمليات المزامنة الكاملة استرداد جميع الأحداث خلال فترة زمنية محددة لإنشاء رمز مميز جديد وصالح للمزامنة.

  2. يتم فحص كل حدث تم تعديله لتحديد ما إذا كان له مكالمة فيديو تابعة لجهة خارجية.
  3. إذا كان الحدث يتضمن مؤتمرًا، يتم فحصه لمعرفة ما تم تغييره. بناءً على التغيير، قد يكون من الضروري تعديل المؤتمر المرتبط. على سبيل المثال، إذا تم حذف حدث، من المحتمل أن تحذف الإضافة مكالمة الفيديو أيضًا.
  4. يتم إجراء أي تغييرات مطلوبة على المؤتمر من خلال إجراء طلبات بيانات من واجهة برمجة التطبيقات إلى نظام تابع لجهة خارجية.
  5. بعد إجراء جميع التغييرات اللازمة، خزِّن nextSyncToken التي تعرضها طريقة Calendar.Events.list(). يمكن العثور على رمز المزامنة هذا في الصفحة الأخيرة من النتائج التي يعرضها استدعاء Calendar.Events.list().

تعديل حدث "تقويم Google"

في بعض الحالات، قد تحتاج إلى تعديل حدث "تقويم Google" عند إجراء عملية مزامنة. إذا اخترت إجراء ذلك، يمكنك إجراء تحديث الحدث باستخدام طلب الخدمة المتقدّمة في "تقويم Google" المناسب. احرص على استخدام التحديث الشرطي باستخدام عنوان 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.

  }
}