Class Evernote::EDAM::Type::Publishing
In: ruby/lib/Evernote/EDAM/types_types.rb
Parent: Object

If a Notebook has been opened to the public, the Notebook will have a reference to one of these structures, which gives the location and optional description of the externally-visible public Notebook. <dl> <dt>uri</dt>

  <dd>If this field is present, then the notebook is published for
  mass consumption on the Internet under the provided URI, which is
  relative to a defined base publishing URI defined by the service.
  This field can only be modified via the web service GUI ... publishing
  cannot be modified via an offline client.
  <br/>
  Length:  EDAM_PUBLISHING_URI_LEN_MIN - EDAM_PUBLISHING_URI_LEN_MAX
  <br/>
  Regex:  EDAM_PUBLISHING_URI_REGEX
  </dd>

<dt>order</dt>

  <dd>When the notes are publicly displayed, they will be sorted
  based on the requested criteria.
  </dd>

<dt>ascending</dt>

  <dd>If this is set to true, then the public notes will be
  displayed in ascending order (e.g. from oldest to newest).  Otherwise,
  the notes will be displayed in descending order (e.g. newest to oldest).
  </dd>

<dt>publicDescription</dt>

  <dd>This field may be used to provide a short
  description of the notebook, which may be displayed when (e.g.) the
  notebook is shown in a public view.  Can't begin or end with a space.
  <br/>
  Length:  EDAM_PUBLISHING_DESCRIPTION_LEN_MIN -
           EDAM_PUBLISHING_DESCRIPTION_LEN_MAX
  <br/>
  Regex:  EDAM_PUBLISHING_DESCRIPTION_REGEX
  </dd>

</dl>

Methods

Included Modules

::Thrift::Struct ::Thrift::Struct_Union

Constants

URI = 1
ORDER = 2
ASCENDING = 3
PUBLICDESCRIPTION = 4
FIELDS = { URI => {:type => ::Thrift::Types::STRING, :name => 'uri', :optional => true}, ORDER => {:type => ::Thrift::Types::I32, :name => 'order', :optional => true, :enum_class => Evernote::EDAM::Type::NoteSortOrder}, ASCENDING => {:type => ::Thrift::Types::BOOL, :name => 'ascending', :optional => true}, PUBLICDESCRIPTION => {:type => ::Thrift::Types::STRING, :name => 'publicDescription', :optional => true}

Public Instance methods

[Source]

      # File ruby/lib/Evernote/EDAM/types_types.rb, line 1148
1148:               def struct_fields; FIELDS; end

[Source]

      # File ruby/lib/Evernote/EDAM/types_types.rb, line 1150
1150:               def validate
1151:                 unless @order.nil? || Evernote::EDAM::Type::NoteSortOrder::VALID_VALUES.include?(@order)
1152:                   raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field order!')
1153:                 end
1154:               end

[Validate]