Class: Evernote::EDAM::NoteStore::RelatedResultSpec

Inherits:

Object

• Object
• Evernote::EDAM::NoteStore::RelatedResultSpec

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/note_store_types.rb

Overview

entities, via findRelated(), together with a description of what type of entities and how many you are seeking in the RelatedResult.

maxNotes

Return notes that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTES will be silently capped. If you do not set this field, then no notes will be returned.

maxNotebooks

Return notebooks that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_NOTEBOOKS will be silently capped. If you do not set this field, then no notebooks will be returned.

maxTags

Return tags that are related to the query, but no more than this many. Any value greater than EDAM_RELATED_MAX_TAGS will be silently capped. If you do not set this field, then no tags will be returned.

writableNotebooksOnly

Require that all returned related notebooks are writable. The user will be able to create notes in all returned notebooks. However, individual notes returned may still belong to notebooks in which the user lacks the ability to create notes.

includeContainingNotebooks

If set to true, return the containingNotebooks field in the RelatedResult, which will contain the list of notebooks to to which the returned related notes belong.

Constant Summary

MAXNOTES =

1

MAXNOTEBOOKS =

2

MAXTAGS =

3

WRITABLENOTEBOOKSONLY =

4

INCLUDECONTAININGNOTEBOOKS =

5

FIELDS =

{
  MAXNOTES => {:type => ::Thrift::Types::I32, :name => 'maxNotes', :optional => true},
  MAXNOTEBOOKS => {:type => ::Thrift::Types::I32, :name => 'maxNotebooks', :optional => true},
  MAXTAGS => {:type => ::Thrift::Types::I32, :name => 'maxTags', :optional => true},
  WRITABLENOTEBOOKSONLY => {:type => ::Thrift::Types::BOOL, :name => 'writableNotebooksOnly', :optional => true},
  INCLUDECONTAININGNOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeContainingNotebooks', :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 1080

def struct_fields; FIELDS; end

#validate ⇒ Object

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

def validate
end