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

#include <Types.h>

Inheritance diagram for qevercloud::RelatedQuery:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QString > noteGuid
 
Optional< QString > plainText
 
Optional< NoteFilterfilter
 
Optional< QString > referenceUri
 
Optional< QString > context
 
Optional< QString > cacheKey
 

Detailed Description

A description of the thing for which we are searching for related entities.

You must specify either noteGuid or plainText, but not both. filter and referenceUri are optional.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ cacheKey

Optional< QString > qevercloud::RelatedQuery::cacheKey

If set and non-empty, this is an indicator for the server whether it is actually necessary to perform a new findRelated call at all. Cache Keys are opaque strings which are returned by the server as part of "RelatedResult" in response to a "NoteStore.findRelated" query. Cache Keys are inherently query specific.

If set to an empty string, this indicates that the server should generate a cache key in the response as part of "RelatedResult".

If not set, the server will not attempt to generate a cache key at all.

◆ context

Optional< QString > qevercloud::RelatedQuery::context

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

◆ filter

Optional< NoteFilter > qevercloud::RelatedQuery::filter

The list of criteria that will constrain the notes being considered related. Please note that some of the parameters may be ignored, such as order and ascending.

◆ localData

EverCloudLocalData qevercloud::RelatedQuery::localData

See the declaration of EverCloudLocalData for details

◆ noteGuid

Optional< QString > qevercloud::RelatedQuery::noteGuid

The GUID of an existing note in your account for which related entities will be found.

◆ plainText

Optional< QString > qevercloud::RelatedQuery::plainText

A string of plain text for which to find related entities. You should provide a text block with a number of characters between EDAM_RELATED_PLAINTEXT_LEN_MIN and EDAM_RELATED_PLAINTEXT_LEN_MAX.

◆ referenceUri

Optional< QString > qevercloud::RelatedQuery::referenceUri

A URI string specifying a reference entity, around which "relatedness" should be based. This can be an URL pointing to a web page, for example.