qevercloud::RelatedQuery Struct Reference

#include <types.h>

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

Public Attributes
Optional< QString >	noteGuid
Optional< QString >	plainText
Optional< NoteFilter >	filter
Optional< QString >	referenceUri

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

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

inline

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

inline

Member Data Documentation

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.

Optional< QString > qevercloud::RelatedQuery::noteGuid

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

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.

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.