qevercloud::RelatedResultSpec Struct Reference

#include <types.h>

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

Public Attributes
Optional< qint32 >	maxNotes
Optional< qint32 >	maxNotebooks
Optional< qint32 >	maxTags
Optional< bool >	writableNotebooksOnly
Optional< bool >	includeContainingNotebooks

Detailed Description

A description of the thing for which the service will find related entities, via findRelated(), together with a description of what type of entities and how many you are seeking in the RelatedResult.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< bool > qevercloud::RelatedResultSpec::includeContainingNotebooks

If set to true, return the containingNotebooks field in the RelatedResult, which will contain the list of notebooks to to which the returned related notes belong.

Optional< qint32 > qevercloud::RelatedResultSpec::maxNotebooks

Return notebooks that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTEBOOKS will be silently capped. If you do not set this field, then no notebooks will be returned.

Optional< qint32 > qevercloud::RelatedResultSpec::maxNotes

Return notes that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTES will be silently capped. If you do not set this field, then no notes will be returned.

Optional< qint32 > qevercloud::RelatedResultSpec::maxTags

Return tags that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_TAGS will be silently capped. If you do not set this field, then no tags will be returned.

Optional< bool > qevercloud::RelatedResultSpec::writableNotebooksOnly

Require that all returned related notebooks are writable. The user will be able to create notes in all returned notebooks. However, individual notes returned may still belong to notebooks in which the user lacks the ability to create notes.