Class: Evernote::EDAM::NoteStore::RelatedQuery

Inherits:

Object

• Object
• Evernote::EDAM::NoteStore::RelatedQuery

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/note_store_types.rb

Overview

entities.

You must specify either noteGuid or plainText, but not both. filter and referenceUri are optional.

<dl> <dt>noteGuid</dt> <dd>The GUID of an existing note in your account for which related

entities will be found.</dd>

<dt>plainText</dt> <dd>A string of plain text for which to find related entities.

You should provide a text block with a number of characters between
EDAM_RELATED_PLAINTEXT_LEN_MIN and EDAM_RELATED_PLAINTEXT_LEN_MAX.
</dd>

<dt>filter</dt> <dd>The list of criteria that will constrain the notes being considered

related.
Please note that some of the parameters may be ignored, such as
<em>order</em> and <em>ascending</em>.

</dd>

<dt>referenceUri</dt> <dd>A URI string specifying a reference entity, around which “relatedness”

should be based. This can be an URL pointing to a web page, for example.

</dd> </dl>

Constant Summary

NOTEGUID =

1

PLAINTEXT =

2

FILTER =

3

REFERENCEURI =

4

FIELDS =

{
  NOTEGUID => {:type => ::Thrift::Types::STRING, :name => 'noteGuid', :optional => true},
  PLAINTEXT => {:type => ::Thrift::Types::STRING, :name => 'plainText', :optional => true},
  FILTER => {:type => ::Thrift::Types::STRUCT, :name => 'filter', :class => ::Evernote::EDAM::NoteStore::NoteFilter, :optional => true},
  REFERENCEURI => {:type => ::Thrift::Types::STRING, :name => 'referenceUri', :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 968

def struct_fields; FIELDS; end

#validate ⇒ Object

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

def validate
end