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

#include <Types.h>

Inheritance diagram for qevercloud::RelatedResultSpec:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< qint32 > maxNotes
 
Optional< qint32 > maxNotebooks
 
Optional< qint32 > maxTags
 
Optional< bool > writableNotebooksOnly
 
Optional< bool > includeContainingNotebooks
 
Optional< bool > includeDebugInfo
 
Optional< qint32 > maxExperts
 
Optional< qint32 > maxRelatedContent
 
Optional< QSet< RelatedContentType > > relatedContentTypes
 

Properties

Optional QSet
 

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

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ includeContainingNotebooks

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.

◆ includeDebugInfo

Optional< bool > qevercloud::RelatedResultSpec::includeDebugInfo

If set to true, indicate that debug information should be returned in the 'debugInfo' field of RelatedResult. Note that the call may be slower if this flag is set.

◆ localData

EverCloudLocalData qevercloud::RelatedResultSpec::localData

See the declaration of EverCloudLocalData for details

◆ maxExperts

Optional< qint32 > qevercloud::RelatedResultSpec::maxExperts

This can only be used when making a findRelated call against a business. Find users within your business who have knowledge about the specified query. No more than this many users will be returned. Any value greater than EDAM_RELATED_MAX_EXPERTS will be silently capped.

◆ maxNotebooks

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.

◆ maxNotes

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.

◆ maxRelatedContent

Optional< qint32 > qevercloud::RelatedResultSpec::maxRelatedContent

Return snippets of related content that is related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_RELATED_CONTENT will be silently capped. If you do not set this field, then no related content will be returned.

◆ maxTags

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.

◆ relatedContentTypes

Optional<QSet<RelatedContentType> > qevercloud::RelatedResultSpec::relatedContentTypes

Specifies the types of Related Content that should be returned.

◆ writableNotebooksOnly

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.

Property Documentation

◆ QSet

Optional qevercloud::RelatedResultSpec::QSet