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

#include <Types.h>

Inheritance diagram for qevercloud::RelatedResult:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< QList< Note > > notes
 
Optional< QList< Notebook > > notebooks
 
Optional< QList< Tag > > tags
 
Optional< QList< NotebookDescriptor > > containingNotebooks
 
Optional< QString > debugInfo
 
Optional< QList< UserProfile > > experts
 
Optional< QList< RelatedContent > > relatedContent
 
Optional< QString > cacheKey
 
Optional< qint32 > cacheExpires
 

Properties

Optional QList
 

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

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ cacheExpires

Optional< qint32 > qevercloud::RelatedResult::cacheExpires

If set, clients should reuse this response for any situations where the same input parameters are applicable for up to this many seconds after receiving this result.

After this time has passed, the client may request a new result from the service, but it should supply the stored cacheKey to the service when checking for an update.

◆ cacheKey

Optional< QString > qevercloud::RelatedResult::cacheKey

If set and non-empty, this cache key may be used in subsequent "NoteStore.findRelated" calls (via "RelatedQuery") to re-use previous responses that were cached on the client-side, instead of actually performing another search.

If set to an empty string, this indicates that the server could not determine a specific key for this response, but the client should nevertheless remove any previously cached result for this request.

If unset/null, it is up to the client whether to re-use cached results or to use the server's response.

If set to the exact non-empty cache key that was specified in "RelatedQuery.cacheKey", this indicates that the server decided that cached results could be reused.

Depending on the cache key specified in the query, the "RelatedResult" may only be partially filled. For each set field, the client should replace the corresponding part in the previously cached result with the new partial result.

For example, for a specific query that has both "RelatedResultSpec.maxNotes" and "RelatedResultSpec.maxRelatedContent" set to positive values, the server may decide that the previously requested and cached Related Content are unchanged, but new results for Related Notes are available. The response will have a new cache key and have "RelatedResult.notes" set, but have "RelatedResult.relatedContent" unset (not just empty, but really unset).

In this situation, the client should replace any cached notes with the newly returned "RelatedResult.notes", but it can re-use the previously cached entries for "RelatedResult.relatedContent". List fields that are set, but empty indicate that no results could be found; the cache should be updated correspondingly.

◆ containingNotebooks

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.

◆ debugInfo

Optional< QString > qevercloud::RelatedResult::debugInfo

NOT DOCUMENTED

◆ experts

Optional<QList<UserProfile> > qevercloud::RelatedResult::experts

If experts have been requested to be included, this will return a list of users within your business who have knowledge about the specified query.

◆ localData

EverCloudLocalData qevercloud::RelatedResult::localData

See the declaration of EverCloudLocalData for details

◆ notebooks

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

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

◆ notes

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

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

◆ relatedContent

Optional<QList<RelatedContent> > qevercloud::RelatedResult::relatedContent

If related content has been requested to be included, this will be the list of related content snippets.

◆ tags

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

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

Property Documentation

◆ QList

Optional qevercloud::RelatedResult::QList