qevercloud::NotesMetadataList Struct Reference

#include <types.h>

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

Public Attributes
qint32	startIndex
qint32	totalNotes
QList< NoteMetadata >	notes
Optional< QStringList >	stoppedWords
Optional< QStringList >	searchedWords
Optional< qint32 >	updateCount

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

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

inline

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

inline

Member Data Documentation

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.

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.

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.

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.

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) )

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.