Người dùng có thể thoải mái cập nhật hoặc xoá các sự kiện trên Lịch Google của mình. Nếu người dùng cập nhật một sự kiện sau khi tạo hội nghị cho sự kiện đó, thì có thể tiện ích bổ sung của bạn cần phản hồi 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 bên thứ ba của bạn 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ó thay đổi về sự kiện 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 kém.
Quá trình cập nhật dữ liệu hội nghị khi 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 Apps Script. Trình kích hoạt này sẽ hoạt động bất cứ khi nào có thay đổi về sự kiện trong một lịch cụ thể. 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ỉ những 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ả các thay đổi được 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à thực hiện các nội dung cập nhật cho phù hợp.
Quy trình đồng bộ hoá chung như sau:
- Lần đầu tiên người dùng tạo một hội nghị, quy trình đồng bộ hoá sẽ được khởi tạo.
- 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 của họ, 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.
- Hàm kích hoạt sẽ 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ó thay đổi nào cần cập nhật một hội nghị liên kết của bên thứ ba hay không.
- Mọi nội dung cập nhật bắt buộc đều được thực hiện cho các hội nghị bằng cách đưa ra yêu cầu API của bên thứ ba.
- Một mã thông báo đồng bộ hoá mới được lưu trữ để lần thực thi trình 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 chạy quá trình đồng bộ hoá
Sau khi tạo thành công một hội nghị trên hệ thống của bên thứ ba, tiện ích bổ sung sẽ tạo một trình 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 trình kích hoạt chưa tồn tại.
Sau khi tạo sự kiện kích hoạt, quá trình khởi tạo sẽ kết thúc bằng cách tạo mã đồng bộ hoá ban đầu. Việc này được thực hiện bằng cách thực thi trực tiếp hàm kích hoạt.
Tạo điều kiện kích hoạt trên 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 được đính kèm bị thay đổi. Bạn có thể thực hiện việc này bằng cách tạo một EventUpdated
trình kích hoạt có thể cài đặt. 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 một điều kiện kích hoạt là khi người dùng tạo hội nghị đầu tiên, vì tại thời điểm đó, người dùng bắt đầu sử dụng tiện ích bổ sung. Sau khi tạo một hội nghị 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 người dùng này có sự kiện kích hoạt hay không. Nếu không, tiện ích bổ sung sẽ tạo sự kiện kích hoạt.
Triển khai hàm kích hoạt đồng bộ hoá
Các hàm kích hoạt sẽ được thực thi khi Apps Script phát hiện thấy một điều kiện khiến điều kiện kích hoạt hoạt động.
EventUpdated
Trình kích hoạt lịch 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ụ thể.
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 phải thực hiện những việc sau:
- Thực hiện lệnh gọi
Calendar.Events.list()
dịch vụ nâng cao của Lịch bằng cách sử dụngsyncToken
để 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ã đồng bộ hoá, bạn sẽ giảm số lượng sự kiện mà tiện ích bổ sung phải kiểm tra.Khi hàm kích hoạt thực thi mà không có mã thông báo đồng bộ hoá hợp lệ, hàm này sẽ quay lại đồng bộ hoá toàn bộ. Quá trình đồng bộ hoá toàn bộ chỉ đơn giản là cố gắng truy xuất tất cả các sự kiện trong một khoảng thời gian quy định để tạo mã thông báo đồng bộ hoá mới, hợp lệ.
- 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ị truyền hình của bên thứ ba hay không.
- Nếu một sự kiện có hội nghị, thì sự kiện đó sẽ được kiểm tra để xem những thay đổi đã diễn ra. Tuỳ thuộc vào nội dung thay đổi, bạn có thể phải sửa đổi hội nghị được liên kết. Ví dụ: nếu một sự kiện bị xoá thì tiện ích bổ sung cũng nên xoá hội nghị truyền hình.
- Mọi thay đổi cần thiết đối với hội nghị đều được thực hiện bằng cách gọi API đến hệ thống của bên thứ ba.
- 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ứcCalendar.Events.list()
trả về. Mã thông báo đồng bộ hoá này nằm trên trang kết quả cuối cùng do lệnh gọiCalendar.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 việc nà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. 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 ngăn những thay đổi của bạn vô tình ghi đè những 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 hội nghị được liên kết.
/** * 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. } }