Đang đồng bộ hóa các thay đổi của hội nghị trên lịch

Người dùng có thể tự do cập nhật hoặc xoá sự kiện trên Lịch Google. Nếu người dùng cập nhật một sự kiện sau khi tạo một hội nghị, thì tiện ích bổ sung của bạn có thể cần phải thích ứng với sự thay đổi đó bằng cách cập nhật dữ liệu hội nghị. Nếu hệ thống hội nghị truyền hình của bên thứ ba phụ thuộc vào việc theo dõi dữ liệu sự kiện, thì việc không cập nhật hội nghị khi có sự kiện thay đổi có thể khiến hội nghị không sử dụng được và dẫn đến trải nghiệm người dùng không tốt.

Quá trình cập nhật dữ liệu hội nghị theo các thay đổi đối với sự kiện trên Lịch Google được gọi là đồng bộ hoá. Bạn có thể đồng bộ hoá các thay đổi về sự kiện bằng cách tạo một trình kích hoạt có thể cài đặt trong Apps Script. Trình kích hoạt này sẽ kích hoạt bất cứ khi nào sự kiện thay đổi trong một lịch nhất định. Rất tiếc, trình kích hoạt không báo cáo những sự kiện đã thay đổi và bạn không thể giới hạn chỉ ở các sự kiện có hội nghị do bạn tạo. Thay vào đó, bạn phải yêu cầu danh sách tất cả thay đổi đã thực hiện đối với lịch kể từ lần đồng bộ hoá gần đây nhất, lọc qua danh sách sự kiện và cập nhật cho phù hợp.

Sau đây là quy trình đồng bộ hoá chung:

1. Vào lần đầu tiên người dùng tạo một hội nghị truyền hình, quá trình đồng bộ hoá sẽ được khởi chạy.
2. Bất cứ khi nào người dùng tạo, cập nhật hoặc xoá một trong các sự kiện trên Lịch, trình kích hoạt sẽ thực thi một hàm kích hoạt trong dự án tiện ích bổ sung của bạn.
3. Hàm điều kiện kích hoạt kiểm tra tập hợp các thay đổi về sự kiện kể từ lần đồng bộ hoá gần đây nhất và xác định xem có sự kiện nào cần cập nhật hội nghị của bên thứ ba được liên kết hay không.
4. Mọi nội dung cập nhật bắt buộc đều được thực hiện đối với các hội nghị bằng cách tạo yêu cầu API của bên thứ ba.
5. Mã thông báo đồng bộ hoá mới được lưu trữ để lần thực thi điều kiện kích hoạt tiếp theo chỉ cần kiểm tra các thay đổi gần đây nhất đối với lịch.

Khởi động quá trình đồng bộ hoá

Sau khi tạo thành công một hội nghị truyền hình trên hệ thống của bên thứ ba, tiện ích bổ sung sẽ tạo một điều kiện kích hoạt có thể cài đặt để phản hồi các thay đổi về sự kiện trong lịch này, nếu chưa có điều kiện kích hoạt này.

Sau khi tạo điều kiện kích hoạt, quá trình khởi chạy sẽ hoàn tất bằng cách tạo mã thông báo đồng bộ hoá ban đầu. Bạn có thể thực hiện việc này bằng cách trực tiếp thực thi hàm kích hoạt.

Tạo điều kiện kích hoạt Lịch

Để đồng bộ hoá, tiện ích bổ sung của bạn cần phát hiện thời điểm một sự kiện trên Lịch có hội nghị truyền hình đính kèm bị thay đổi. Bạn có thể thực hiện việc này bằng cách tạo điều kiện kích hoạt có thể cài đặt EventUpdated. Tiện ích bổ sung của bạn chỉ cần một trình kích hoạt cho mỗi lịch và có thể tạo các trình kích hoạt đó theo phương thức lập trình.

Thời điểm thích hợp để tạo điều kiện kích hoạt là khi người dùng tạo cuộc họp đầu tiên, vì tại thời điểm đó, người dùng đang bắt đầu sử dụng tiện ích bổ sung. Sau khi tạo cuộc họp và xác minh không có lỗi, tiện ích bổ sung của bạn sẽ kiểm tra xem có điều kiện kích hoạt cho người dùng này hay không, nếu không thì hãy tạo điều kiện kích hoạt.

Lưu ý: Để tạo điều kiện kích hoạt, tiện ích bổ sung của bạn phải được uỷ quyền bằng phạm vi https://www.googleapis.com/auth/calendar.readonly và https://www.googleapis.com/auth/script.scriptapp.

Triển khai hàm kích hoạt đồng bộ hoá

Các hàm điều kiện kích hoạt được thực thi khi Apps Script phát hiện một điều kiện kích hoạt điều kiện kích hoạt. Trình kích hoạt Lịch EventUpdated sẽ kích hoạt khi người dùng tạo, sửa đổi hoặc xoá bất kỳ sự kiện nào trong một lịch được chỉ định.

Bạn phải triển khai hàm kích hoạt mà tiện ích bổ sung của bạn sử dụng. Hàm kích hoạt này sẽ thực hiện những việc sau:

1. Thực hiện lệnh gọi Calendar.Events.list() của dịch vụ nâng cao Lịch bằng cách sử dụng syncToken để truy xuất danh sách các sự kiện đã thay đổi kể từ lần đồng bộ hoá gần đây nhất. Bằng cách sử dụng mã thông báo đồng bộ hoá, bạn giảm được số lượng sự kiện mà tiện ích bổ sung của bạn phải kiểm tra.

   Khi thực thi hàm kích hoạt mà không có mã thông báo đồng bộ hoá hợp lệ, hàm này sẽ chuyển về quá trình đồng bộ hoá toàn bộ. Quá trình đồng bộ hoá toàn bộ chỉ cần cố gắng truy xuất tất cả sự kiện trong khoảng thời gian quy định để tạo một mã thông báo đồng bộ hoá mới, hợp lệ.

   Thận trọng: Đôi khi, máy chủ sẽ vô hiệu hoá mã thông báo đồng bộ hoá, dẫn đến lỗi Sync token is no longer valid. Khi điều này xảy ra, mã của bạn sẽ tiến hành đồng bộ hoá đầy đủ và thay thế mọi mã thông báo đồng bộ hoá mà bạn đã lưu trữ.
2. Mỗi sự kiện đã sửa đổi sẽ được kiểm tra để xác định xem sự kiện đó có liên kết với một hội nghị của bên thứ ba hay không.
3. Nếu một sự kiện có hội nghị, thì hội nghị đó sẽ được kiểm tra để xem có gì thay đổi. Tuỳ vào nội dung thay đổi, bạn có thể cần phải sửa đổi hội nghị liên kết. Ví dụ: nếu một sự kiện đã bị xoá, thì tiện ích bổ sung cũng có thể xoá hội nghị.
4. Mọi thay đổi cần thiết đối với hội nghị đều được thực hiện bằng cách thực hiện lệnh gọi API đến hệ thống của bên thứ ba.
5. Sau khi thực hiện tất cả các thay đổi cần thiết, hãy lưu trữ nextSyncToken do phương thức Calendar.Events.list() trả về. Mã thông báo đồng bộ hoá này nằm trên trang cuối của kết quả do lệnh gọi Calendar.Events.list() trả về.

Cập nhật sự kiện trên Lịch Google

Trong một số trường hợp, bạn có thể muốn cập nhật sự kiện trên Lịch Google khi thực hiện đồng bộ hoá. Nếu bạn chọn làm như vậy, hãy cập nhật sự kiện bằng yêu cầu dịch vụ nâng cao của Lịch Google thích hợp. Hãy nhớ sử dụng tính năng cập nhật có điều kiện với tiêu đề If-Match. Điều này giúp các thay đổi của bạn không vô tình ghi đè các thay đổi đồng thời do người dùng thực hiện trong một ứng dụng khác.

Ví dụ:

Ví dụ sau đây cho thấy cách bạn có thể thiết lập tính năng đồng bộ hoá cho các sự kiện trên lịch và các cuộc họp liên quan.

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

  }
}