qevercloud::SyncState Struct Reference

#include <types.h>

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

Public Attributes
Timestamp	currentTime
Timestamp	fullSyncBefore
qint32	updateCount
Optional< qint64 >	uploaded

Detailed Description

This structure encapsulates the information about the state of the user's account for the purpose of "state based" synchronization.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Timestamp qevercloud::SyncState::currentTime

The server's current date and time.

Timestamp qevercloud::SyncState::fullSyncBefore

The cutoff date and time for client caches to be updated via incremental synchronization. Any clients that were last synched with the server before this date/time must do a full resync of all objects. This cutoff point will change over time as archival data is deleted or special circumstances on the service require resynchronization.

qint32 qevercloud::SyncState::updateCount

Indicates the total number of transactions that have been committed within the account. This reflects (for example) the number of discrete additions or modifications that have been made to the data in this account (tags, notes, resources, etc.). This number is the "high water mark" for Update Sequence Numbers (USN) within the account.

Optional< qint64 > qevercloud::SyncState::uploaded

The total number of bytes that have been uploaded to this account in the current monthly period. This can be compared against Accounting.uploadLimit (from the UserStore) to determine how close the user is to their monthly upload limit. This value may not be present if the SyncState has been retrieved by a caller that only has read access to the account.