Class: Evernote::EDAM::NoteStore::NotesMetadataList

Inherits:

Object

• Object
• Evernote::EDAM::NoteStore::NotesMetadataList

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/note_store_types.rb

Overview

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>

Constant Summary

STARTINDEX =

1

TOTALNOTES =

2

NOTES =

3

STOPPEDWORDS =

4

SEARCHEDWORDS =

5

UPDATECOUNT =

6

FIELDS =

{
  STARTINDEX => {:type => ::Thrift::Types::I32, :name => 'startIndex'},
  TOTALNOTES => {:type => ::Thrift::Types::I32, :name => 'totalNotes'},
  NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::NoteStore::NoteMetadata}},
  STOPPEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'stoppedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
  SEARCHEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'searchedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
  UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount', :optional => true}
}

Constants included from Thrift::Struct_Union

Thrift::Struct_Union::CONTAINER_TYPES

Instance Method Summary

• #struct_fields ⇒ Object
• #validate ⇒ Object

Methods included from Thrift::Struct

#<=>, #==, #differences, #eql?, field_accessor, #fields_with_default_values, generate_accessors, #hash, #initialize, #inspect, qmark_isset_method, #read, #write

Methods included from Thrift::Struct_Union

#each_field, #field_info, #inspect_collection, #inspect_field, #is_container?, #name_to_id, #read_field, #sorted_field_ids, #write_container, #write_data

Instance Method Details

#struct_fields ⇒ Object

# File 'lib/Evernote/EDAM/note_store_types.rb', line 658

def struct_fields; FIELDS; end

#validate ⇒ Object

Raises:

• (::Thrift::ProtocolException)

# 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