qevercloud::SyncChunk Struct Reference

#include <types.h>

Public Member Functions
bool	operator== (const SyncChunk &other) const
bool	operator!= (const SyncChunk &other) const

Public Attributes
Timestamp	currentTime
Optional< qint32 >	chunkHighUSN
qint32	updateCount
Optional< QList< Note > >	notes
Optional< QList< Notebook > >	notebooks
Optional< QList< Tag > >	tags
Optional< QList< SavedSearch > >	searches
Optional< QList< Resource > >	resources
Optional< QList< Guid > >	expungedNotes
Optional< QList< Guid > >	expungedNotebooks
Optional< QList< Guid > >	expungedTags
Optional< QList< Guid > >	expungedSearches
Optional< QList< LinkedNotebook > >	linkedNotebooks
Optional< QList< Guid > >	expungedLinkedNotebooks

Detailed Description

This structure is given out by the NoteStore when a client asks to receive the current state of an account. The client asks for the server's state one chunk at a time in order to allow clients to retrieve the state of a large account without needing to transfer the entire account in a single message.

The server always gives SyncChunks using an ascending series of Update Sequence Numbers (USNs).

Member Function Documentation

bool qevercloud::SyncChunk::operator!= ( const SyncChunk &  other ) const

inline

bool qevercloud::SyncChunk::operator== ( const SyncChunk &  other ) const

inline

Member Data Documentation

Optional< qint32 > qevercloud::SyncChunk::chunkHighUSN

The highest USN for any of the data objects represented in this sync chunk. If there are no objects in the chunk, this will not be set.

Timestamp qevercloud::SyncChunk::currentTime

The server's current date and time.

Optional< QList< Guid > > qevercloud::SyncChunk::expungedLinkedNotebooks

If present, the GUIDs of all of the LinkedNotebooks that were permanently expunged in this chunk.

Optional< QList< Guid > > qevercloud::SyncChunk::expungedNotebooks

If present, the GUIDs of all of the notebooks that were permanently expunged in this chunk. When a notebook is expunged, this implies that all of its child notes (and their resources) were also expunged.

Optional< QList< Guid > > qevercloud::SyncChunk::expungedNotes

If present, the GUIDs of all of the notes that were permanently expunged in this chunk.

Optional< QList< Guid > > qevercloud::SyncChunk::expungedSearches

If present, the GUIDs of all of the saved searches that were permanently expunged in this chunk.

Optional< QList< Guid > > qevercloud::SyncChunk::expungedTags

If present, the GUIDs of all of the tags that were permanently expunged in this chunk.

Optional< QList< LinkedNotebook > > qevercloud::SyncChunk::linkedNotebooks

If present, this is a list of non-expunged LinkedNotebooks that have a USN in this chunk.

Optional< QList< Notebook > > qevercloud::SyncChunk::notebooks

If present, this is a list of non-expunged notebooks that have a USN in this chunk. This will include notebooks that are "deleted" but not expunged (i.e. in the trash).

Optional< QList< Note > > qevercloud::SyncChunk::notes

If present, this is a list of non-expunged notes that have a USN in this chunk. This will include notes that are "deleted" but not expunged (i.e. in the trash). The notes will include their list of tags and resources, but the note content, resource content, resource recognition data and resource alternate data will not be supplied.

Optional< QList< Resource > > qevercloud::SyncChunk::resources

If present, this is a list of the non-expunged resources that have a USN in this chunk. This will include the metadata for each resource, but not its binary contents or recognition data, which must be retrieved separately.

Optional< QList< SavedSearch > > qevercloud::SyncChunk::searches

If present, this is a list of non-expunged searches that have a USN in this chunk.

Optional< QList< Tag > > qevercloud::SyncChunk::tags

If present, this is a list of the non-expunged tags that have a USN in this chunk.

qint32 qevercloud::SyncChunk::updateCount

The total number of updates that have been performed in the service for this account. This is equal to the highest USN within the account at the point that this SyncChunk was generated. If updateCount and chunkHighUSN are identical, that means that this is the last chunk in the account ... there is no more recent information.