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

#include <Types.h>

Inheritance diagram for qevercloud::NoteFilter:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< qint32 > order
 
Optional< bool > ascending
 
Optional< QString > words
 
Optional< GuidnotebookGuid
 
Optional< QList< Guid > > tagGuids
 
Optional< QString > timeZone
 
Optional< bool > inactive
 
Optional< QString > emphasized
 
Optional< bool > includeAllReadableNotebooks
 
Optional< bool > includeAllReadableWorkspaces
 
Optional< QString > context
 
Optional< QString > rawWords
 
Optional< QByteArray > searchContextBytes
 

Properties

Optional QList
 

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

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ ascending

Optional< bool > qevercloud::NoteFilter::ascending

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

◆ context

Optional< QString > qevercloud::NoteFilter::context

Specifies the context to consider when determining result ranking. Clients must leave this value unset unless they wish to explicitly specify a known non-default context.

◆ emphasized

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.

◆ inactive

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.

◆ includeAllReadableNotebooks

Optional< bool > qevercloud::NoteFilter::includeAllReadableNotebooks

If true, then the search will include all business notebooks that are readable by the user. A business authentication token must be supplied for this option to take effect when calling search APIs.

◆ includeAllReadableWorkspaces

Optional< bool > qevercloud::NoteFilter::includeAllReadableWorkspaces

If true, then the search will include all workspaces that are readable by the user. A business authentication token must be supplied for this option to take effect when calling search APIs.

◆ localData

EverCloudLocalData qevercloud::NoteFilter::localData

See the declaration of EverCloudLocalData for details

◆ notebookGuid

Optional< Guid > qevercloud::NoteFilter::notebookGuid

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

◆ order

Optional< qint32 > qevercloud::NoteFilter::order

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

◆ rawWords

Optional< QString > qevercloud::NoteFilter::rawWords

If present, the raw user query input. Accepts the full search grammar documented in the Evernote API Overview.

◆ searchContextBytes

Optional< QByteArray > qevercloud::NoteFilter::searchContextBytes

Specifies the correlating information about the current search session, in byte array. If this request is not for the first page of search results, the client should populate this field with the value of searchContextBytes from the NotesMetadataList of the original search response.

◆ tagGuids

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

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

◆ timeZone

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

◆ words

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.

Property Documentation

◆ QList

Optional qevercloud::NoteFilter::QList