class Evernote::EDAM::NoteStore::NotesMetadataList
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.
<dl>
<dt>startIndex</dt> <dd> The starting index within the overall set of notes. This is also the number of notes that are "before" this list in the set. </dd> <dt>totalNotes</dt> <dd> 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) ) </dd> <dt>notes</dt> <dd> 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. </dd> <dt>stoppedWords</dt> <dd> 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. </dd> <dt>searchedWords</dt> <dd> 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. </dd> <dt>updateCount</dt> <dd> 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. </dd> </dl>
Constants
- FIELDS
- NOTES
- SEARCHEDWORDS
- STARTINDEX
- STOPPEDWORDS
- TOTALNOTES
- UPDATECOUNT
Public Instance Methods
struct_fields()
click to toggle source
# File lib/Evernote/EDAM/note_store_types.rb, line 658 def struct_fields; FIELDS; end
validate()
click to toggle source
# File lib/Evernote/EDAM/note_store_types.rb, line 660 def validate raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field startIndex is unset!') unless @startIndex raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field totalNotes is unset!') unless @totalNotes raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field notes is unset!') unless @notes end