Listing Synced Documents

This section explains what is a checkpoint and how to use it.

A checkpoint is a string value associated to a connector. Multiple checkpoints are possible for a connector.

Two methods are used to manipulate the checkpoint: Get and Set methods.

The setCheckpoint method can be used to sync the previous operations by setting the sync parameter to true. It can also be used to know whether the operation status is Searchable. See Operations and states.

Typical use cases of checkpoint operations:

• Store the last synchronization date of a folder.

• Store the last eventId in a journal of events.

• Safely sync to disk previous operations (sync set to true).

• Allow tracking of operations state to know whether documents are searchable; see Operations and states.

Below is a code sample to sync documents at the end of the scan operation.

// Example of sync.
public void SyncDocuments(final Date indexingStartDate) {
papi.setCheckpoint(String.valueOf(indexingStartDate), "sync date", true);
}

// Example of sync.
        public void SyncDocuments(DateTime indexingStartDate)
{
    papi.SetCheckpoint(indexingStartDate.ToString(), "sync date", true);
}

Below is a code sample to enumerate the documents of a specified folder.

for (final SyncedEntry doc : papi.enumerateSyncedEntries("myfolder", EnumerationMode.RECURSIVE_DOCUMENTS)) {
  System.out.println("uri : " + doc.getUri() + " stamp : " + doc.getStamp());
}
// no need to close Iterator because the end is reached        

//Example of the enumeration of document in a specified folder.
public void Enumerate()
{ 
    string rootPath = "myfolder";
    EnumerationMode mode = EnumerationMode.RECURSIVE_DOCUMENTS;
    foreach (SyncedEntry entry in new 
    SyncedEntriesEnumerator(papi.EnumerateSyncedEntries(rootPath, mode)))
    {
        Console.WriteLine("URI = " + entry.Uri + ", Stamp = " + (entry.Stamp ?? "(null)"));
    }
}