QEverCloud  6.1.0
Unofficial Evernote Cloud API for Qt
Public Member Functions | Public Attributes | Properties | List of all members
qevercloud::SyncChunk Struct Reference

#include <Types.h>

Inheritance diagram for qevercloud::SyncChunk:
qevercloud::Printable

Public Member Functions

virtual void print (QTextStream &strm) const override
 
bool operator== (const SyncChunk &other) const
 
bool operator!= (const SyncChunk &other) const
 
- Public Member Functions inherited from qevercloud::Printable
 Printable ()=default
 
virtual ~Printable ()=default
 
virtual QString toString () const
 

Public Attributes

EverCloudLocalData localData
 
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
 

Properties

Optional QList
 

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

◆ operator!=()

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

◆ operator==()

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

◆ print()

virtual void qevercloud::SyncChunk::print ( QTextStream &  strm) const
overridevirtual

Implements qevercloud::Printable.

Member Data Documentation

◆ chunkHighUSN

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.

◆ currentTime

Timestamp qevercloud::SyncChunk::currentTime

The server's current date and time.

◆ expungedLinkedNotebooks

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

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

◆ expungedNotebooks

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.

◆ expungedNotes

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

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

◆ expungedSearches

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

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

◆ expungedTags

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

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

◆ linkedNotebooks

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

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

◆ localData

EverCloudLocalData qevercloud::SyncChunk::localData

See the declaration of EverCloudLocalData for details

◆ notebooks

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

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

◆ notes

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.

◆ resources

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.

◆ searches

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

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

◆ tags

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

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

◆ updateCount

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.

Property Documentation

◆ QList

Optional qevercloud::SyncChunk::QList