Automatic and Manual Syncing

By default, PSPDFKit Instant automatically synchronizes annotations with your PSPDFKit Sever in real time. This is configurable, and you can choose for it to sync manually when your app requests it instead.

Using a network, especially a cellular network, is one of the most energy-intensive tasks on mobile devices. While we do our best to minimize the energy impact of Instant, it can be reduced further by disabling listening for changes from the server or by syncing less often after local changes are made.

Syncing after making local changes and listening for server changes can be configured separately. However, syncing always sends all local changes and fetches all changes from the server. It is not possible to fetch remote changes without pushing local changes, or to push local changes without fetching remote changes.

Automatic Syncing

By default, when you show a document managed by Instant in an InstantPdfFragment, real-time syncing of annotations is fully automatic: Instant will push local changes to the server as they happen and listen for changes from the server.

If you don’t show the document in an InstantPdfFragment, you can enable listening for changes using setListenToServerChanges on the InstantPdfDocument.

Instant will use the network efficiently by coalescing changes with a one-second delay by default. You can reduce energy consumption at the cost of less immediate syncing by increasing the delay with setDelayForSyncingLocalChanges on the document.

Disabling Listening for Server Changes

If your app does not require real-time syncing, it may be better to fetch changes from the server manually to reduce energy consumption — for example, when the view showing the document appears, or with a button the user can tap.

If you show the document in an InstantPdfFragment, you can disable listening using setListenToServerChangesWhenVisible. Then sync manually whenever you want to by calling syncAnnotations or syncAnnotationsAsync on the document.

Disabling Syncing after Local Changes

In addition to disabling listening for changes from the server (see above), you can disable syncing after local changes are made by calling setDelayForSyncingLocalChanges on a document with SYNC_LOCAL_CHANGES_DISABLED. This means Instant will never sync annotations with the server unless your app requests this by calling syncAnnotations or syncAnnotationsAsync on the document.

It is possible to configure Instant to not sync after local changes are made but to listen for changes. This combination makes little sense and is not recommended, as the local changes would be pushed at seemingly random times when changes are received from the server.