Class: Evernote::EDAM::Type::LinkedNotebook

Inherits:
Object
  • Object
show all
Includes:
Thrift::Struct, Thrift::Struct_Union
Defined in:
lib/Evernote/EDAM/types_types.rb

Overview

another user’s account.

<dl> <dt>shareName</dt> <dd>the display name of the shared notebook.

The link owner can change this.</dd>

<dt>username</dt> <dd>the username of the user who owns the shared or public notebook</dd>

<dt>shardId</dt> <dd>the shard ID of the notebook if the notebook is not public</dt>

<dt>shareKey</dt> <dd>the secret key that provides access to the shared notebook</dd>

<dt>uri</dt> <dd>the identifier of the public notebook</dd>

<dt>guid</dt>

<dd>The unique identifier of this linked notebook.  Will be set whenever
a linked notebook is retrieved from the service, but may be null when a client
is creating a linked notebook.
<br/>
Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
<br/>
Regex:  EDAM_GUID_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>noteStoreUrl</dt>

<dd>
This field will contain the full URL that clients should use to make
NoteStore requests to the server shard that contains that notebook's data.
I.e. this is the URL that should be used to create the Thrift HTTP client
transport to send messages to the NoteStore service for the account.
</dd>

<dt>webApiUrlPrefix:</dt>

<dd>
This field will contain the initial part of the URLs that should be used
to make requests to Evernote's thin client "web API", which provide
optimized operations for clients that aren't capable of manipulating
the full contents of accounts via the full Thrift data model. Clients
should concatenate the relative path for the various servlets onto the
end of this string to construct the full URL, as documented on our
developer web site.
</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.  The link owner can change this and this field is for the benefit
of the link owner.
</dd>

<dt>businessId</dt>

<dd>If set, this will be the unique identifier for the business that owns
the notebook to which the linked notebook refers.

</dl>

Constant Summary collapse

SHARENAME = 
2
USERNAME = 
3
SHARDID = 
4
SHAREKEY = 
5
URI = 
6
GUID = 
7
UPDATESEQUENCENUM = 
8
NOTESTOREURL = 
9
WEBAPIURLPREFIX = 
10
STACK = 
11
BUSINESSID = 
12
FIELDS = 
{
  SHARENAME => {:type => ::Thrift::Types::STRING, :name => 'shareName', :optional => true},
  USERNAME => {:type => ::Thrift::Types::STRING, :name => 'username', :optional => true},
  SHARDID => {:type => ::Thrift::Types::STRING, :name => 'shardId', :optional => true},
  SHAREKEY => {:type => ::Thrift::Types::STRING, :name => 'shareKey', :optional => true},
  URI => {:type => ::Thrift::Types::STRING, :name => 'uri', :optional => true},
  GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true},
  UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum', :optional => true},
  NOTESTOREURL => {:type => ::Thrift::Types::STRING, :name => 'noteStoreUrl', :optional => true},
  WEBAPIURLPREFIX => {:type => ::Thrift::Types::STRING, :name => 'webApiUrlPrefix', :optional => true},
  STACK => {:type => ::Thrift::Types::STRING, :name => 'stack', :optional => true},
  BUSINESSID => {:type => ::Thrift::Types::I32, :name => 'businessId', :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 



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

def struct_fields; FIELDS; end

#validate ⇒ Object 



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

def validate
end