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

#include <Types.h>

Inheritance diagram for qevercloud::SyncChunkFilter:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< bool > includeNotes
 
Optional< bool > includeNoteResources
 
Optional< bool > includeNoteAttributes
 
Optional< bool > includeNotebooks
 
Optional< bool > includeTags
 
Optional< bool > includeSearches
 
Optional< bool > includeResources
 
Optional< bool > includeLinkedNotebooks
 
Optional< bool > includeExpunged
 
Optional< bool > includeNoteApplicationDataFullMap
 
Optional< bool > includeResourceApplicationDataFullMap
 
Optional< bool > includeNoteResourceApplicationDataFullMap
 
Optional< bool > includeSharedNotes
 
Optional< bool > omitSharedNotebooks
 
Optional< QString > requireNoteContentClass
 
Optional< QSet< QString > > notebookGuids
 

Properties

Optional QSet
 

Detailed Description

This structure is used with the 'getFilteredSyncChunk' call to provide fine-grained control over the data that's returned when a client needs to synchronize with the service. Each flag in this structure specifies whether to include one class of data in the results of that call.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ includeExpunged

Optional< bool > qevercloud::SyncChunkFilter::includeExpunged

If true, then the server will include the 'expunged' data for any type of included data. For example, if 'includeTags' and 'includeExpunged' are both true, then the SyncChunks.expungedTags field will be set with the GUIDs of tags that have been expunged from the server.

◆ includeLinkedNotebooks

Optional< bool > qevercloud::SyncChunkFilter::includeLinkedNotebooks

If true, then the server will include the SyncChunks.linkedNotebooks field.

◆ includeNoteApplicationDataFullMap

Optional< bool > qevercloud::SyncChunkFilter::includeNoteApplicationDataFullMap

If true, then the values for the applicationData map will be filled in, assuming notes and note attributes are being returned. Otherwise, only the keysOnly field will be filled in.

◆ includeNoteAttributes

Optional< bool > qevercloud::SyncChunkFilter::includeNoteAttributes

If true, then the server will include the 'attributes' field on all of the Notes that are in SyncChunks.notes. If 'includeNotes' is false, then this will have no effect.

◆ includeNotebooks

Optional< bool > qevercloud::SyncChunkFilter::includeNotebooks

If true, then the server will include the SyncChunks.notebooks field

◆ includeNoteResourceApplicationDataFullMap

Optional< bool > qevercloud::SyncChunkFilter::includeNoteResourceApplicationDataFullMap

If true, then the fullMap values for the applicationData map will be filled in for resources found inside of notes, assuming resources are being returned in notes (includeNoteResources is true). Otherwise, only the keysOnly field will be filled in.

◆ includeNoteResources

Optional< bool > qevercloud::SyncChunkFilter::includeNoteResources

If true, then the server will include the 'resources' field on all of the Notes that are in SyncChunk.notes. If 'includeNotes' is false, then this will have no effect.

◆ includeNotes

Optional< bool > qevercloud::SyncChunkFilter::includeNotes

If true, then the server will include the SyncChunks.notes field

◆ includeResourceApplicationDataFullMap

Optional< bool > qevercloud::SyncChunkFilter::includeResourceApplicationDataFullMap

If true, then the fullMap values for the applicationData map will be filled in, assuming resources and resource attributes are being returned (includeResources is true). Otherwise, only the keysOnly field will be filled in.

◆ includeResources

Optional< bool > qevercloud::SyncChunkFilter::includeResources

If true, then the server will include the SyncChunks.resources field. Since the Resources are also provided with their Note (in the Notes.resources list), this is primarily useful for clients that want to watch for changes to individual Resources due to recognition data being added.

◆ includeSearches

Optional< bool > qevercloud::SyncChunkFilter::includeSearches

If true, then the server will include the SyncChunks.searches field

◆ includeSharedNotes

Optional< bool > qevercloud::SyncChunkFilter::includeSharedNotes

If true, then the service will include the sharedNotes field on all notes that are in SyncChunk.notes. If 'includeNotes' is false, then this will have no effect.

◆ includeTags

Optional< bool > qevercloud::SyncChunkFilter::includeTags

If true, then the server will include the SyncChunks.tags field

◆ localData

EverCloudLocalData qevercloud::SyncChunkFilter::localData

See the declaration of EverCloudLocalData for details

◆ notebookGuids

Optional<QSet<QString> > qevercloud::SyncChunkFilter::notebookGuids

If set, then restrict the returned notebooks, notes, and resources to those associated with one of the notebooks whose GUID is provided in this list. If not set, then no filtering on notebook GUID will be performed. If you set this field, you may not also set includeExpunged else an EDAMUserException with an error code of DATA_CONFLICT will be thrown. You only need to set this field if you want to restrict the returned entities more than what your authentication token allows you to access. For example, there is no need to set this field for single notebook tokens such as for shared notebooks. You can use this field to synchronize a newly discovered business notebook while incrementally synchronizing a business account, in which case you will only need to consider setting includeNotes, includeNotebooks, includeNoteAttributes, includeNoteResources, and maybe some of the "FullMap" fields.

◆ omitSharedNotebooks

Optional< bool > qevercloud::SyncChunkFilter::omitSharedNotebooks

NOT DOCUMENTED

◆ requireNoteContentClass

Optional< QString > qevercloud::SyncChunkFilter::requireNoteContentClass

If set, then only send notes whose content class matches this value. The value can be a literal match or, if the last character is an asterisk, a prefix match.

Property Documentation

◆ QSet

Optional qevercloud::SyncChunkFilter::QSet