Class: Evernote::EDAM::Type::Resource

Inherits:

Object

• Object
• Evernote::EDAM::Type::Resource

Includes:

Thrift::Struct, Thrift::Struct_Union

Defined in:

lib/Evernote/EDAM/types_types.rb

Overview

through a Resource entry. <dl> <dt>guid</dt>

<dd>The unique identifier of this resource.  Will be set whenever
a resource is retrieved from the service, but may be null when a client
is creating a resource.
<br/>
Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
<br/>
Regex:  EDAM_GUID_REGEX
</dd>

<dt>noteGuid</dt>

<dd>The unique identifier of the Note that holds this
Resource. Will be set whenever the resource is retrieved from the service,
but may be null when a client is creating a resource.
<br/>
Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
<br/>
Regex:  EDAM_GUID_REGEX
</dd>

<dt>data</dt>

<dd>The contents of the resource.
Maximum length:  The data.body is limited to EDAM_RESOURCE_SIZE_MAX_FREE
for free accounts and EDAM_RESOURCE_SIZE_MAX_PREMIUM for premium accounts.
</dd>

<dt>mime</dt>

<dd>The MIME type for the embedded resource.  E.g. "image/gif"
<br/>
Length:  EDAM_MIME_LEN_MIN - EDAM_MIME_LEN_MAX
<br/>
Regex:  EDAM_MIME_REGEX
</dd>

<dt>width</dt>

<dd>If set, this contains the display width of this resource, in
pixels.
</dd>

<dt>height</dt>

<dd>If set, this contains the display height of this resource,
in pixels.
</dd>

<dt>duration</dt>

<dd>DEPRECATED: ignored.
</dd>

<dt>active</dt>

<dd>DEPRECATED: ignored.
</dd>

<dt>recognition</dt>

<dd>If set, this will hold the encoded data that provides
information on search and recognition within this resource.
</dd>

<dt>attributes</dt>

<dd>A list of the attributes for this resource.
</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>alternateData</dt>

<dd>Some Resources may be assigned an alternate data format by the service
which may be more appropriate for indexing or rendering than the original
data provided by the user.  In these cases, the alternate data form will
be available via this Data element.  If a Resource has no alternate form,
this field will be unset.</dd>

</dl>

Constant Summary

GUID =

1

NOTEGUID =

2

DATA =

3

MIME =

4

WIDTH =

5

HEIGHT =

6

DURATION =

7

ACTIVE =

8

RECOGNITION =

9

ATTRIBUTES =

11

UPDATESEQUENCENUM =

12

ALTERNATEDATA =

13

FIELDS =

{
  GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true},
  NOTEGUID => {:type => ::Thrift::Types::STRING, :name => 'noteGuid', :optional => true},
  DATA => {:type => ::Thrift::Types::STRUCT, :name => 'data', :class => ::Evernote::EDAM::Type::Data, :optional => true},
  MIME => {:type => ::Thrift::Types::STRING, :name => 'mime', :optional => true},
  WIDTH => {:type => ::Thrift::Types::I16, :name => 'width', :optional => true},
  HEIGHT => {:type => ::Thrift::Types::I16, :name => 'height', :optional => true},
  DURATION => {:type => ::Thrift::Types::I16, :name => 'duration', :optional => true},
  ACTIVE => {:type => ::Thrift::Types::BOOL, :name => 'active', :optional => true},
  RECOGNITION => {:type => ::Thrift::Types::STRUCT, :name => 'recognition', :class => ::Evernote::EDAM::Type::Data, :optional => true},
  ATTRIBUTES => {:type => ::Thrift::Types::STRUCT, :name => 'attributes', :class => ::Evernote::EDAM::Type::ResourceAttributes, :optional => true},
  UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum', :optional => true},
  ALTERNATEDATA => {:type => ::Thrift::Types::STRUCT, :name => 'alternateData', :class => ::Evernote::EDAM::Type::Data, :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/types_types.rb', line 1171

def struct_fields; FIELDS; end

#validate ⇒ Object

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

def validate
end