Class Evernote::EDAM::UserStore::AuthenticationResult
In: ruby/lib/Evernote/EDAM/user_store_types.rb
Parent: Object
 When an authentication (or re-authentication) is performed, this structure
 provides the result to the client.

<dl>

 <dt>currentTime:</dt>
   <dd>
   The server-side date and time when this result was
   generated.
   </dd>
 <dt>authenticationToken:</dt>
   <dd>
   Holds an opaque, ASCII-encoded token that can be
   used by the client to perform actions on a NoteStore.
   </dd>
 <dt>expiration:</dt>
   <dd>
   Holds the server-side date and time when the
   authentication token will expire.
   This time can be compared to "currentTime" to produce an expiration
   time that can be reconciled with the client's local clock.
   </dd>
 <dt>user:</dt>
   <dd>
   Holds the information about the account which was
   authenticated if this was a full authentication.  May be absent if this
   particular authentication did not require user information.
   </dd>
 <dt>publicUserInfo:</dt>
   <dd>
   If this authentication result was achieved without full permissions to
   access the full User structure, this field may be set to give back
   a more limited public set of data.
   </dd>
 </dl>

Methods

Included Modules

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

Constants

CURRENTTIME = 1
AUTHENTICATIONTOKEN = 2
EXPIRATION = 3
USER = 4
PUBLICUSERINFO = 5
FIELDS = { CURRENTTIME => {:type => ::Thrift::Types::I64, :name => 'currentTime'}, AUTHENTICATIONTOKEN => {:type => ::Thrift::Types::STRING, :name => 'authenticationToken'}, EXPIRATION => {:type => ::Thrift::Types::I64, :name => 'expiration'}, USER => {:type => ::Thrift::Types::STRUCT, :name => 'user', :class => Evernote::EDAM::Type::User, :optional => true}, PUBLICUSERINFO => {:type => ::Thrift::Types::STRUCT, :name => 'publicUserInfo', :class => Evernote::EDAM::UserStore::PublicUserInfo, :optional => true}

Public Instance methods

[Source]

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

[Source]

     # File ruby/lib/Evernote/EDAM/user_store_types.rb, line 112
112:               def validate
113:                 raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field currentTime is unset!') unless @currentTime
114:                 raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field authenticationToken is unset!') unless @authenticationToken
115:                 raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field expiration is unset!') unless @expiration
116:               end

[Validate]