Class: Evernote::EDAM::NoteStore::NoteFilter
- Inherits:
-
Object
- Object
- Evernote::EDAM::NoteStore::NoteFilter
- Includes:
- Thrift::Struct, Thrift::Struct_Union
- Defined in:
- lib/Evernote/EDAM/note_store_types.rb
Overview
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>
If present, a search query string that will filter the set of notes to be returned.
Accepts the full search grammar documented in the Evernote API Overview.
</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>
<dt>emphasized</dt>
<dd>
If present, a search query string that may or may not influence the notes
to be returned, both in terms of coverage as well as of order. Think of it
as a wish list, not a requirement.
Accepts the full search grammar documented in the Evernote API Overview.
</dd>
</dl>
Constant Summary collapse
- ORDER =
1
- ASCENDING =
2
- WORDS =
3
- NOTEBOOKGUID =
4
- TAGGUIDS =
5
- TIMEZONE =
6
- INACTIVE =
7
- EMPHASIZED =
8
- 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}, EMPHASIZED => {:type => ::Thrift::Types::STRING, :name => 'emphasized', :optional => true} }
Constants included from Thrift::Struct_Union
Thrift::Struct_Union::CONTAINER_TYPES
Instance Method Summary collapse
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
443 |
# File 'lib/Evernote/EDAM/note_store_types.rb', line 443 def struct_fields; FIELDS; end |
#validate ⇒ Object
445 446 |
# File 'lib/Evernote/EDAM/note_store_types.rb', line 445 def validate end |