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

#include <Types.h>

Inheritance diagram for qevercloud::NotesMetadataList:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
qint32 startIndex
 
qint32 totalNotes
 
QList< NoteMetadatanotes
 
Optional< QStringList > stoppedWords
 
Optional< QStringList > searchedWords
 
Optional< qint32 > updateCount
 
Optional< QByteArray > searchContextBytes
 
Optional< QString > debugInfo
 

Detailed Description

This structure is returned from calls to the findNotesMetadata function to give the high-level metadata about a subset of Notes that are found to match a specified NoteFilter in a search.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ debugInfo

Optional< QString > qevercloud::NotesMetadataList::debugInfo

Depends on the value of context in NoteFilter, this field may contain debug information if the service decides to do so.

◆ localData

EverCloudLocalData qevercloud::NotesMetadataList::localData

See the declaration of EverCloudLocalData for details

◆ notes

QList< NoteMetadata > qevercloud::NotesMetadataList::notes

The list of metadata for Notes in this range. The set of optional fields that are set in each metadata structure will depend on the NotesMetadataResultSpec provided by the caller when the search was performed. Only the 'guid' field will be guaranteed to be set in each Note.

◆ searchContextBytes

Optional< QByteArray > qevercloud::NotesMetadataList::searchContextBytes

Specifies the correlating information about the current search session, in byte array.

◆ searchedWords

Optional< QStringList > qevercloud::NotesMetadataList::searchedWords

If the NoteList was produced using a text based search query that included viable search words or quoted expressions, this will include a list of those words. Any stopped words will not be included in this list.

◆ startIndex

qint32 qevercloud::NotesMetadataList::startIndex

The starting index within the overall set of notes. This is also the number of notes that are "before" this list in the set.

◆ stoppedWords

Optional< QStringList > qevercloud::NotesMetadataList::stoppedWords

If the NoteList was produced using a text based search query that included words that are not indexed or searched by the service, this will include a list of those ignored words.

◆ totalNotes

qint32 qevercloud::NotesMetadataList::totalNotes

The number of notes in the larger set. This can be used to calculate how many notes are "after" this note in the set. (I.e. remaining = totalNotes - (startIndex + notes.length) )

◆ updateCount

Optional< qint32 > qevercloud::NotesMetadataList::updateCount

Indicates the total number of transactions that have been committed within the account. This reflects (for example) the number of discrete additions or modifications that have been made to the data in this account (tags, notes, resources, etc.). This number is the "high water mark" for Update Sequence Numbers (USN) within the account.