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

A small structure for returning a list of notes out of a larger set. More...

Public Member Functions

bool operator!= (const NoteList &other) const
 
bool operator== (const NoteList &other) const
 

Public Attributes

QList< Notenotes
 The list of notes from this range. More...
 
Optional< QStringList > 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. More...
 
qint32 startIndex
 The starting index within the overall set of notes. More...
 
Optional< QStringList > 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.
 
qint32 totalNotes
 The number of notes in the larger set. More...
 
Optional< qint32 > updateCount
 Indicates the total number of transactions that have been committed within the account. More...
 

Detailed Description

A small structure for returning a list of notes out of a larger set.

Member Data Documentation

QList< Note > qevercloud::NoteList::notes

The list of notes from this range.

The Notes will include all metadata (attributes, resources, etc.), but will not include the ENML content of the note or the binary contents of any resources.

Optional< QStringList > qevercloud::NoteList::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.

qint32 qevercloud::NoteList::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.

qint32 qevercloud::NoteList::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) )

Optional< qint32 > qevercloud::NoteList::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.