Class Evernote::EDAM::NoteStore::NoteFilter
In: ruby/lib/Evernote/EDAM/note_store_types.rb
Parent: Object
 A list of criteria that are used to indicate which notes are desired from
 the account.  This is used in queries to the NoteStore to determine
 which notes should be retrieved.

<dl>

 <dt>order</dt>
   <dd>
   The NoteSortOrder value indicating what criterion should be
   used to sort the results of the filter.
   </dd>

 <dt>ascending</dt>
   <dd>
   If true, the results will be ascending in the requested
   sort order.  If false, the results will be descending.
   </dd>

 <dt>words</dt>
   <dd>
   The string query containing keywords to match, if present.
   </dd>

 <dt>notebookGuid</dt>
   <dd>
   If present, the Guid of the notebook that must contain
   the notes.
   </dd>

 <dt>tagGuids</dt>
   <dd>
   If present, the list of tags (by GUID) that must be present
   on the notes.
   </dd>

 <dt>timeZone</dt>
   <dd>
   The zone ID for the user, which will be used to interpret
   any dates or times in the queries that do not include their desired zone
   information.
   For example, if a query requests notes created "yesterday", this
   will be evaluated from the provided time zone, if provided.
   The format must be encoded as a standard zone ID such as
   "America/Los_Angeles".
   </dd>

 <dt>inactive</dt>
   <dd>
   If true, then only notes that are not active (i.e. notes in
   the Trash) will be returned. Otherwise, only active notes will be returned.
   There is no way to find both active and inactive notes in a single query.
   </dd>
 </dl>

Methods

Included Modules

::Thrift::Struct ::Thrift::Struct_Union

Constants

ORDER = 1
ASCENDING = 2
WORDS = 3
NOTEBOOKGUID = 4
TAGGUIDS = 5
TIMEZONE = 6
INACTIVE = 7
FIELDS = { ORDER => {:type => ::Thrift::Types::I32, :name => 'order', :optional => true}, ASCENDING => {:type => ::Thrift::Types::BOOL, :name => 'ascending', :optional => true}, WORDS => {:type => ::Thrift::Types::STRING, :name => 'words', :optional => true}, NOTEBOOKGUID => {:type => ::Thrift::Types::STRING, :name => 'notebookGuid', :optional => true}, TAGGUIDS => {:type => ::Thrift::Types::LIST, :name => 'tagGuids', :element => {:type => ::Thrift::Types::STRING}, :optional => true}, TIMEZONE => {:type => ::Thrift::Types::STRING, :name => 'timeZone', :optional => true}, INACTIVE => {:type => ::Thrift::Types::BOOL, :name => 'inactive', :optional => true}

Public Instance methods

[Source]

     # File ruby/lib/Evernote/EDAM/note_store_types.rb, line 281
281:               def struct_fields; FIELDS; end

[Source]

     # File ruby/lib/Evernote/EDAM/note_store_types.rb, line 283
283:               def validate
284:               end

[Validate]