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

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. More...

Public Member Functions

bool operator!= (const SyncChunkFilter &other) const
 
bool operator== (const SyncChunkFilter &other) const
 

Public Attributes

Optional< bool > includeExpunged
 If true, then the server will include the 'expunged' data for any type of included data. More...
 
Optional< bool > includeLinkedNotebooks
 If true, then the server will include the SyncChunks.linkedNotebooks field.
 
Optional< bool > includeNoteApplicationDataFullMap
 If true, then the values for the applicationData map will be filled in, assuming notes and note attributes are being returned. More...
 
Optional< bool > includeNoteAttributes
 If true, then the server will include the 'attributes' field on all of the Notes that are in SyncChunks.notes. More...
 
Optional< bool > includeNotebooks
 If true, then the server will include the SyncChunks.notebooks field.
 
Optional< bool > 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). More...
 
Optional< bool > includeNoteResources
 If true, then the server will include the 'resources' field on all of the Notes that are in SyncChunk.notes. More...
 
Optional< bool > includeNotes
 If true, then the server will include the SyncChunks.notes field.
 
Optional< bool > 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). More...
 
Optional< bool > includeResources
 If true, then the server will include the SyncChunks.resources field. More...
 
Optional< bool > includeSearches
 If true, then the server will include the SyncChunks.searches field.
 
Optional< bool > includeTags
 If true, then the server will include the SyncChunks.tags field.
 
Optional< QString > requireNoteContentClass
 If set, then only send notes whose content class matches this value. More...
 

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 Data Documentation

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.

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.

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.

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.

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.

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.

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.

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.