Class: Evernote::EDAM::NoteStore::RelatedResult

Inherits:

Object

• Object
• Evernote::EDAM::NoteStore::RelatedResult

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/note_store_types.rb

Overview

notebooks, and tags fields will be in decreasing order of expected relevance. It is possible that fewer results than requested will be returned even if there are enough distinct entities in the account in cases where the relevance is estimated to be low.

<dl> <dt>notes</dt> <dd>If notes have been requested to be included, this will be the

list of notes.</dd>

<dt>notebooks</dt> <dd>If notebooks have been requested to be included, this will be the

list of notebooks.</dd>

<dt>tags</dt> <dd>If tags have been requested to be included, this will be the list

of tags.</dd>

</dl>

<dt>containingNotebooks</dt> <dd>If includeContainingNotebooks is set to true

in the RelatedResultSpec, return the list of notebooks to
to which the returned related notes belong. The notebooks in this
list will occur once per notebook GUID and are represented as
NotebookDescriptor objects.</dd>

</dl> </dl>

Constant Summary

NOTES =

1

NOTEBOOKS =

2

TAGS =

3

CONTAININGNOTEBOOKS =

4

FIELDS =

{
  NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Note}, :optional => true},
  NOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'notebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Notebook}, :optional => true},
  TAGS => {:type => ::Thrift::Types::LIST, :name => 'tags', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Tag}, :optional => true},
  CONTAININGNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'containingNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::NotebookDescriptor}, :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 1011

def struct_fields; FIELDS; end

#validate ⇒ Object

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

def validate
end