class Evernote::EDAM::NoteStore::RelatedResultSpec

A description of the thing for which the service will find related entities, via findRelated(), together with a description of what type of entities and how many you are seeking in the RelatedResult.

<dl> <dt>maxNotes</dt> <dd>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.</dd>

<dt>maxNotebooks</dt> <dd>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.</dd>

<dt>maxTags</dt> <dd>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.</dd>

</dl>

<dt>writableNotebooksOnly</dt> <dd>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.</dd>

</dl>

<dt>includeContainingNotebooks</dt> <dd>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.</dd>

</dl> </dl>

Constants

FIELDS
INCLUDECONTAININGNOTEBOOKS
MAXNOTEBOOKS
MAXNOTES
MAXTAGS
WRITABLENOTEBOOKSONLY

Public Instance Methods

struct_fields() click to toggle source
# File lib/Evernote/EDAM/note_store_types.rb, line 1080
def struct_fields; FIELDS; end
validate() click to toggle source
# File lib/Evernote/EDAM/note_store_types.rb, line 1082
def validate
end