QEverCloud 6.1.0
Unofficial Evernote Cloud API for Qt
Loading...
Searching...
No Matches
qevercloud::SavedSearch Struct Reference

#include <Types.h>

Inheritance diagram for qevercloud::SavedSearch:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
Optional< Guidguid
Optional< QString > name
Optional< QString > query
Optional< QueryFormatformat
Optional< qint32 > updateSequenceNum
Optional< SavedSearchScopescope

Detailed Description

A named search associated with the account that can be quickly re-used.

Member Function Documentation

◆ operator!=()

bool qevercloud::SavedSearch::operator!= ( const SavedSearch & other) const
inline

◆ operator==()

bool qevercloud::SavedSearch::operator== ( const SavedSearch & other) const
inline

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ format

Optional< QueryFormat > qevercloud::SavedSearch::format

The format of the query string, to determine how to parse and process it.

◆ guid

Optional< Guid > qevercloud::SavedSearch::guid

The unique identifier of this search. Will be set by the service, so may be omitted by the client when creating.
Length: EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
Regex: EDAM_GUID_REGEX

◆ localData

EverCloudLocalData qevercloud::SavedSearch::localData

See the declaration of EverCloudLocalData for details

◆ name

Optional< QString > qevercloud::SavedSearch::name

The name of the saved search to display in the GUI. The account may only contain one search with a given name (case-insensitive compare). Can't begin or end with a space.
Length: EDAM_SAVED_SEARCH_NAME_LEN_MIN - EDAM_SAVED_SEARCH_NAME_LEN_MAX
Regex: EDAM_SAVED_SEARCH_NAME_REGEX

◆ query

Optional< QString > qevercloud::SavedSearch::query

A string expressing the search to be performed.
Length: EDAM_SAVED_SEARCH_QUERY_LEN_MIN - EDAM_SAVED_SEARCH_QUERY_LEN_MAX

◆ scope

Optional< SavedSearchScope > qevercloud::SavedSearch::scope

Specifies the set of notes that should be included in the search, if possible.

Clients are expected to search as much of the desired scope as possible, with the understanding that a given client may not be able to cover the full specified scope. For example, when executing a search that includes notes in both the owner's account and business notebooks, a mobile client may choose to only search within the user's account because it is not capable of searching both scopes simultaneously. When a search across multiple scopes is not possible, a client may choose which scope to search based on the current application context. If a client cannot search any of the desired scopes, it should refuse to execute the search.

◆ updateSequenceNum

Optional< qint32 > qevercloud::SavedSearch::updateSequenceNum

A number identifying the last transaction to modify the state of this object. The USN values are sequential within an account, and can be used to compare the order of modifications within the service.