Push API Client Methods

This section describes the Push API client methods (using Java conventions) to implement with the corresponding HTTP Push API POST methods.

void ping()
void startPushSession()
void stopPushSession()
void addDocument(Document document) and void addDocumentList(Document[ ] documentList)
void updateDocument(Document document, string[] fields) and void updateDocumentList(Document[ ] documentList, string[][] fieldsList)
void deleteDocument(String uri) and void deleteDocumentList(String[] uris)
void deleteDocumentsRootPath(String rootPath [, Boolean recursive=true] )
DocumentStatus getDocumentStatus(String uri) and DocumentStatus[] getDocumentStatusList(String[] uriList)
ulong setCheckpoint(String checkpoint [, String name] [, sync=false])
String getCheckpoint([String name])
String getCheckpoint([String name, Boolean showSynchronizedOnly])
void clearAllCheckpoints()
CheckpointsInfoIterator enumerateCheckpointsInfo()
CheckpointsInfoIterator enumerateCheckpointsInfo (boolean showSynchronizedOnly)
CheckpointsInfoIterator:: next()
SyncedEntriesIterator::
SyncedEntriesIterator enumerateSyncedEntries(String rootPath, EnumerationMode enumerationMode)
ulong countSyncedEntries(String rootPath, EnumerationMode enumerationMode)
void sync()
void triggerIndexingJob()
boolean areDocumentsSearchable(long serial)
Metadata Examples