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

#include <Types.h>

Inheritance diagram for qevercloud::NoteResultSpec:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< bool > includeContent
 
Optional< bool > includeResourcesData
 
Optional< bool > includeResourcesRecognition
 
Optional< bool > includeResourcesAlternateData
 
Optional< bool > includeSharedNotes
 
Optional< bool > includeNoteAppDataValues
 
Optional< bool > includeResourceAppDataValues
 
Optional< bool > includeAccountLimits
 

Detailed Description

This structure is provided to the getNoteWithResultSpec function to specify the subset of fields that should be included in the Note that is returned. This allows clients to request the minimum set of information that they require when retrieving a note, reducing the size of the response and improving the response time.

If one of the fields in this spec is not set, then it will be treated as 'false' by the service, so that the default behavior is to include none of the fields below in the Note.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ includeAccountLimits

Optional< bool > qevercloud::NoteResultSpec::includeAccountLimits

If true, the Note.limits field will be populated with the note owner's account limits.

◆ includeContent

Optional< bool > qevercloud::NoteResultSpec::includeContent

If true, the Note.content field will be populated with the note's ENML contents.

◆ includeNoteAppDataValues

Optional< bool > qevercloud::NoteResultSpec::includeNoteAppDataValues

If true, the Note.attributes.applicationData.fullMap field will be populated.

◆ includeResourceAppDataValues

Optional< bool > qevercloud::NoteResultSpec::includeResourceAppDataValues

If true, the Note.resource.attributes.applicationData.fullMap field will be populated.

◆ includeResourcesAlternateData

Optional< bool > qevercloud::NoteResultSpec::includeResourcesAlternateData

If true, any Resource elements will include the binary contents of their 'alternateData' field's body, if an alternate form is available.

◆ includeResourcesData

Optional< bool > qevercloud::NoteResultSpec::includeResourcesData

If true, any Resource elements will include the binary contents of their 'data' field's body.

◆ includeResourcesRecognition

Optional< bool > qevercloud::NoteResultSpec::includeResourcesRecognition

If true, any Resource elements will include the binary contents of their 'recognition' field's body if recognition data is available.

◆ includeSharedNotes

Optional< bool > qevercloud::NoteResultSpec::includeSharedNotes

If true, the Note.sharedNotes field will be populated with the note's shares.

◆ localData

EverCloudLocalData qevercloud::NoteResultSpec::localData

See the declaration of EverCloudLocalData for details