gcal.listeventsprops.synctoken

Home > @runlightyear/gcal > ListEventsProps > syncToken

ListEventsProps.syncToken property

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are?: iCalUID orderBy privateExtendedProperty q sharedExtendedProperty timeMin timeMax updatedMin

If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Signature:

syncToken?: string;