Class: Evernote::EDAM::Type::Notebook

Inherits:

Object

Object
Evernote::EDAM::Type::Notebook

Includes:: Thrift::Struct, Thrift::Struct_Union

Defined in:: lib/Evernote/EDAM/types_types.rb

Overview

<dd>The unique identifier of this notebook.
<br/>
Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
<br/>
Regex:  EDAM_GUID_REGEX
</dd>

<dd>A sequence of characters representing the name of the
notebook.  May be changed by clients, but the account may not contain two
notebooks with names that are equal via a case-insensitive comparison.
Can't begin or end with a space.
<br/>
Length:  EDAM_NOTEBOOK_NAME_LEN_MIN - EDAM_NOTEBOOK_NAME_LEN_MAX
<br/>
Regex:  EDAM_NOTEBOOK_NAME_REGEX
</dd>

<dt>updateSequenceNum</dt>

<dd>A number identifying the last transaction to
modify the state of this object.  The USN values are sequential within an
account, and can be used to compare the order of modifications within the
service.
</dd>

<dt>defaultNotebook</dt>

<dd>If true, this notebook should be used for new notes
whenever the user has not (or cannot) specify a desired target notebook.
For example, if a note is submitted via SMTP email.
The service will maintain at most one defaultNotebook per account.
If a second notebook is created or updated with defaultNotebook set to
true, the service will automatically update the prior notebook's
defaultNotebook field to false.  If the default notebook is deleted
(i.e. "active" set to false), the "defaultNotebook" field will be
set to false by the service.  If the account has no default notebook
set, the service will use the most recent notebook as the default.
</dd>

<dt>serviceCreated</dt>

<dd>The time when this notebook was created on the
service. This will be set on the service during creation, and the service
will provide this value when it returns a Notebook to a client.
The service will ignore this value if it is sent by clients.
</dd>

<dt>serviceUpdated</dt>

<dd>The time when this notebook was last modified on the
service.  This will be set on the service during creation, and the service
will provide this value when it returns a Notebook to a client.
The service will ignore this value if it is sent by clients.
</dd>

<dt>publishing</dt>

<dd>If the Notebook has been opened for public access, or
business users shared with their business (i.e. if 'published' is
set to true), then this will point to the set of publishing
information for the Notebook (URI, description, etc.).  A
Notebook cannot be published without providing this information,
but it will persist for later use if publishing is ever disabled
on the Notebook.  Clients that do not wish to change the
publishing behavior of a Notebook should not set this value when
calling NoteStore.updateNotebook().
</dd>

<dt>published</dt>

<dd>If this is set to true, then the Notebook will be
accessible either to the public, or for business users to their business,
via the 'publishing' specification, which must also be set.  If this is set
to false, the Notebook will not be available to the public (or business).
Clients that do not wish to change the publishing behavior of a Notebook
should not set this value when calling NoteStore.updateNotebook().
</dd>

<dt>stack</dt>

<dd>If this is set, then the notebook is visually contained within a stack
of notebooks with this name.  All notebooks in the same account with the
same 'stack' field are considered to be in the same stack.
Notebooks with no stack set are "top level" and not contained within a
stack.
</dd>

<dt>sharedNotebookIds</dt>

<dd><i>DEPRECATED</i> - replaced by sharedNotebooks.</dd>

<dt>sharedNotebooks</dt>

<dd>The list of recipients to whom this notebook has been shared
(one SharedNotebook object per recipient email address). This field will
be unset if you do not have permission to access this data. If you are
accessing the notebook as the owner or via a shared notebook that is
modifiable, then you have access to this data and the value will be set.
This field is read-only. Clients may not make changes to shared notebooks
via this field.
</dd>

<dt>businessNotebook</dt>

<dd>If the notebook is part of a business account and has been published to the
business library, this will contain information for the library listing.
The presence or absence of this field is not a reliable test of whether a given
notebook is in fact a business notebook - the field is only used when a notebook is or
has been published to the business library.
</dd>

<dt>contact</dt>

<dd>Intended for use with Business accounts, this field identifies the user who
has been designated as the "contact".  For notebooks created in business
accounts, the server will automatically set this value to the user who created
the notebook unless Notebook.contact.username has been set, in which that value
will be used.  When updating a notebook, it is common to leave Notebook.contact
field unset, indicating that no change to the value is being requested and that
the existing value, if any, should be preserved.
</dd>

</dl>

Constant Summary collapse

GUID =

NAME =

UPDATESEQUENCENUM =

DEFAULTNOTEBOOK =

SERVICECREATED =

SERVICEUPDATED =

PUBLISHING =

PUBLISHED =

STACK =

SHAREDNOTEBOOKIDS =

SHAREDNOTEBOOKS =

BUSINESSNOTEBOOK =

CONTACT =

RESTRICTIONS =

FIELDS =

{
  GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true},
  NAME => {:type => ::Thrift::Types::STRING, :name => 'name', :optional => true},
  UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum', :optional => true},
  DEFAULTNOTEBOOK => {:type => ::Thrift::Types::BOOL, :name => 'defaultNotebook', :optional => true},
  SERVICECREATED => {:type => ::Thrift::Types::I64, :name => 'serviceCreated', :optional => true},
  SERVICEUPDATED => {:type => ::Thrift::Types::I64, :name => 'serviceUpdated', :optional => true},
  PUBLISHING => {:type => ::Thrift::Types::STRUCT, :name => 'publishing', :class => ::Evernote::EDAM::Type::Publishing, :optional => true},
  PUBLISHED => {:type => ::Thrift::Types::BOOL, :name => 'published', :optional => true},
  STACK => {:type => ::Thrift::Types::STRING, :name => 'stack', :optional => true},
  SHAREDNOTEBOOKIDS => {:type => ::Thrift::Types::LIST, :name => 'sharedNotebookIds', :element => {:type => ::Thrift::Types::I64}, :optional => true},
  SHAREDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'sharedNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::SharedNotebook}, :optional => true},
  BUSINESSNOTEBOOK => {:type => ::Thrift::Types::STRUCT, :name => 'businessNotebook', :class => ::Evernote::EDAM::Type::BusinessNotebook, :optional => true},
  CONTACT => {:type => ::Thrift::Types::STRUCT, :name => 'contact', :class => ::Evernote::EDAM::Type::User, :optional => true},
  RESTRICTIONS => {:type => ::Thrift::Types::STRUCT, :name => 'restrictions', :class => ::Evernote::EDAM::Type::NotebookRestrictions, :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`

2261	# File 'lib/Evernote/EDAM/types_types.rb', line 2261 def struct_fields; FIELDS; end

#validate ⇒ `Object`



2263
2264

# File 'lib/Evernote/EDAM/types_types.rb', line 2263

def validate
end