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

Người dùng có thể tuỳ ý cập nhật hoặc xoá các sự kiện của mình trên Lịch Google. Nếu một người dùng cập nhật một sự kiện sau khi tạo một hội nghị cho sự kiện đó, thì tiện ích bổ sung của bạn có thể cần ứng phó với sự thay đổi bằng cách cập nhật dữ liệu hội nghị truyền hình. 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, nếu không cập nhật được hội nghị về một thay đổi về sự kiện, hội nghị này có thể hiển thị không sử dụng được và dẫn đến trải nghiệm người dùng kém.

Quá trình cập nhật dữ liệu hội nghị truyền hình để phản ánh những 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 tạo một Apps Script trình kích hoạt có thể cài đặt kích hoạt bất cứ khi nào sự kiện thay đổi trong một lịch cụ thể. Rất tiếc, điều kiện 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 báo cáo này thành chỉ những sự kiện có hội nghị truyền hình mà bạn đã tạo. Thay vào đó, bạn phải yêu cầu danh sách tất cả các thay đổi đã thực hiện đối với lịch kể từ lần đồng bộ hóa gần đây nhất, hãy lọc thông 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 xóa một trong các sự kiện trên Lịch của họ trình kích hoạt sẽ thực thi hàm kích hoạt trong dự án tiện ích bổ sung của bạn.
  3. Hàm kích hoạt kiểm tra tập hợp các thay đổi sự kiện kể từ lần đồng bộ hoá và xác định xem có yêu cầu cập nhật bên thứ ba được liên kết hay không hội nghị truyền hình.
  4. Mọi nội dung cập nhật cần thiết đều được thực hiện cho hội nghị truyền hình bằng cách cung cấp dịch vụ của bên thứ ba Yêu cầu API.
  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 những thay đổi gần đây nhất đối với lịch.

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

Sau khi tiện ích bổ sung đã tạo thành công một hội nghị trên hệ thống của bên thứ ba, nó sẽ tạo đ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 tồn tại đ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ẽ kết thúc bằng cách tạo đồng bộ hoá mã thông báo. Việc này được thực hiện 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 khi nào một sự kiện trên Lịch có tệp đính kèm hội nghị truyền hình đã thay đổi. Bạn có thể thực hiện việc này bằng cách tạo một EventUpdated điều kiện kích hoạt có thể cài đặt. Tiện ích bổ sung của bạn chỉ cần một điều kiện kích hoạt cho mỗi lịch và có thể tạo lịch kích hoạt theo cách lập trình.

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

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

Hàm kích hoạt được thực thi khi Apps Script phát hiện một điều kiện gây ra một trình kích hoạt để kích hoạt. EventUpdated điều kiện kích hoạt Lịch kích hoạt khi người dùng tạo, sửa đổi hoặc xóa bất kỳ sự kiện nào trong một sự kiện được chỉ định lịch.

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. Gọi điện cho dịch vụ Lịch nâng cao Calendar.Events.list() bằng syncToken để truy xuất danh sách các sự kiện đã thay đổi kể từ lần diễn ra gần đây nhất đồng bộ hoá. Bằng cách sử dụng mã thông báo đồng bộ hoá, bạn sẽ giảm được số lượng sự kiện mà tiện ích bổ sung của mình cầ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ẽ quay lại thành đồng bộ hoá hoàn toàn. 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 một khoảng thời gian quy định để tạo một lần đồng bộ hoá mới, hợp lệ mã thông báo.

  2. Mỗi sự kiện được sửa đổi sẽ được kiểm tra để xác định xem sự kiện đó có hội nghị truyền hình của bên thứ ba.
  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ỳ thuộc vào sự thay đổi, việc sửa đổi hội nghị truyền hình liên quan có thể là cần thiết. Ví dụ: nếu một sự kiện đã bị xoá thì tiện ích bổ sung sẽ cũng có thể xoá hội nghị truyền hình này.
  4. Bạn có thể thực hiện mọi thay đổi cần thiết đối với hội nghị truyền hình 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 được trả về bằng phương thức Calendar.Events.list(). Mã thông báo đồng bộ hoá này được tìm thấy ở trang kết quả được 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 biểu diễn đồng bộ hoá. Nếu bạn chọn làm việc này, hãy cập nhật sự kiện bằng các Dịch vụ nâng cao của Lịch Google của bạn. Hãy nhớ sử dụng cập nhật có điều kiện với tiêu đề If-Match. Việc này giúp tránh việc các thay đổi của bạn vô tình được thực hiện ghi đè các thay đổi đồng thời do người dùng thực hiện trong một ứng dụng khách khác.

Ví dụ:

Ví dụ sau 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 hội nghị truyền hình 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.

  }
}