qevercloud::RelatedResult Struct Reference

#include <types.h>

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

Public Attributes
Optional< QList< Note > >	notes
Optional< QList< Notebook > >	notebooks
Optional< QList< Tag > >	tags
Optional< QList < NotebookDescriptor > >	containingNotebooks

Detailed Description

The result of calling findRelated(). The contents of the notes, notebooks, and tags fields will be in decreasing order of expected relevance. It is possible that fewer results than requested will be returned even if there are enough distinct entities in the account in cases where the relevance is estimated to be low.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< QList< NotebookDescriptor > > qevercloud::RelatedResult::containingNotebooks

If includeContainingNotebooks is set to true in the RelatedResultSpec, return the list of notebooks to to which the returned related notes belong. The notebooks in this list will occur once per notebook GUID and are represented as NotebookDescriptor objects.

Optional< QList< Notebook > > qevercloud::RelatedResult::notebooks

If notebooks have been requested to be included, this will be the list of notebooks.

Optional< QList< Note > > qevercloud::RelatedResult::notes

If notes have been requested to be included, this will be the list of notes.

Optional< QList< Tag > > qevercloud::RelatedResult::tags

If tags have been requested to be included, this will be the list of tags.