qevercloud::NoteFilter Struct Reference

#include <types.h>

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

Public Attributes
Optional< qint32 >	order
Optional< bool >	ascending
Optional< QString >	words
Optional< Guid >	notebookGuid
Optional< QList< Guid > >	tagGuids
Optional< QString >	timeZone
Optional< bool >	inactive
Optional< QString >	emphasized

Detailed Description

A list of criteria that are used to indicate which notes are desired from the account. This is used in queries to the NoteStore to determine which notes should be retrieved.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< bool > qevercloud::NoteFilter::ascending

If true, the results will be ascending in the requested sort order. If false, the results will be descending.

Optional< QString > qevercloud::NoteFilter::emphasized

If present, a search query string that may or may not influence the notes to be returned, both in terms of coverage as well as of order. Think of it as a wish list, not a requirement. Accepts the full search grammar documented in the Evernote API Overview.

Optional< bool > qevercloud::NoteFilter::inactive

If true, then only notes that are not active (i.e. notes in the Trash) will be returned. Otherwise, only active notes will be returned. There is no way to find both active and inactive notes in a single query.

Optional< Guid > qevercloud::NoteFilter::notebookGuid

If present, the Guid of the notebook that must contain the notes.

Optional< qint32 > qevercloud::NoteFilter::order

The NoteSortOrder value indicating what criterion should be used to sort the results of the filter.

Optional< QList< Guid > > qevercloud::NoteFilter::tagGuids

If present, the list of tags (by GUID) that must be present on the notes.

Optional< QString > qevercloud::NoteFilter::timeZone

The zone ID for the user, which will be used to interpret any dates or times in the queries that do not include their desired zone information. For example, if a query requests notes created "yesterday", this will be evaluated from the provided time zone, if provided. The format must be encoded as a standard zone ID such as "America/Los_Angeles".

Optional< QString > qevercloud::NoteFilter::words

If present, a search query string that will filter the set of notes to be returned. Accepts the full search grammar documented in the Evernote API Overview.