Class: Evernote::EDAM::Type::UserAttributes

Inherits:

Object

Object
Evernote::EDAM::Type::UserAttributes

show all

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

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

Overview

on a User. These are generally less critical than the core User fields.

<dl>

<dt>defaultLocationName</dt>
  <dd>the location string that should be associated
  with the user in order to determine where notes are taken if not otherwise
  specified.<br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>

<dt>defaultLatitude</dt>
  <dd>if set, this is the latitude that should be
  assigned to any notes that have no other latitude information.
  </dd>

<dt>defaultLongitude</dt>
  <dd>if set, this is the longitude that should be
  assigned to any notes that have no other longitude information.
  </dd>

<dt>preactivation</dt>
  <dd>if set, the user account is not yet confirmed for
  login.  I.e. the account has been created, but we are still waiting for
  the user to complete the activation step.
  </dd>

<dt>viewedPromotions</dt>
  <dd>a list of promotions the user has seen.
   This list may occasionally be modified by the system when promotions are
   no longer available.<br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>

<dt>incomingEmailAddress</dt>
  <dd>if set, this is the email address that the
   user may send email to in order to add an email note directly into the
   account via the SMTP email gateway.  This is the part of the email
   address before the '@' symbol ... our domain is not included.
   If this is not set, the user may not add notes via the gateway.<br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>

<dt>recentMailedAddresses</dt>
  <dd>if set, this will contain a list of email
   addresses that have recently been used as recipients
   of outbound emails by the user.  This can be used to pre-populate a
   list of possible destinations when a user wishes to send a note via
   email.<br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX each<br/>
   Max:  EDAM_USER_RECENT_MAILED_ADDRESSES_MAX entries
  </dd>

<dt>comments</dt>
  <dd>Free-form text field that may hold general support
   information, etc.<br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>

<dt>dateAgreedToTermsOfService</dt>
  <dd>The date/time when the user agreed to
   the terms of service.  This can be used as the effective "start date"
   for the account.
  </dd>

<dt>maxReferrals</dt>
  <dd>The number of referrals that the user is permitted
   to make.
  </dd>

<dt>referralCount</dt>
  <dd>The number of referrals sent from this account.
  </dd>

<dt>refererCode</dt>
  <dd>A code indicating where the user was sent from. AKA
   promotion code
  </dd>

<dt>sentEmailDate</dt>
  <dd>The most recent date when the user sent outbound
   emails from the service.  Used with sentEmailCount to limit the number
   of emails that can be sent per day.
  </dd>

<dt>sentEmailCount</dt>
  <dd>The number of emails that were sent from the user
   via the service on sentEmailDate.  Used to enforce a limit on the number
   of emails per user per day to prevent spamming.
  </dd>

<dt>dailyEmailLimit</dt>
  <dd>If set, this is the maximum number of emails that
   may be sent in a given day from this account.  If unset, the server will
   use the configured default limit.
  </dd>

<dt>emailOptOutDate</dt>
  <dd>If set, this is the date when the user asked
   to be excluded from offers and promotions sent by Evernote.  If not set,
   then the user currently agrees to receive these messages.
  </dd>

<dt>partnerEmailOptInDate</dt>
  <dd>If set, this is the date when the user asked
   to be included in offers and promotions sent by Evernote's partners.
   If not sent, then the user currently does not agree to receive these
   emails.
  </dd>

<dt>preferredLanguage</dt>
  <dd>a 2 character language codes based on:
      http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt used for
     localization purposes to determine what language to use for the web
     interface and for other direct communication (e.g. emails).
  </dd>

<dt>preferredCountry</dt>
  <dd>Preferred country code based on ISO 3166-1-alpha-2 indicating the
  users preferred country</dd>

<dt>clipFullPage</dt>
  <dd>Boolean flag set to true if the user wants to clip full pages by
  default when they use the web clipper without a selection.</dd>

<dt>twitterUserName</dt>
  <dd>The username of the account of someone who has chosen to enable
  Twittering into Evernote.  This value is subject to change, since users
  may change their Twitter user name.</dd>

<dt>twitterId</dt>
  <dd>The unique identifier of the user's Twitter account if that user
  has chosen to enable Twittering into Evernote.</dd>

<dt>groupName</dt>
  <dd>A name identifier used to identify a particular set of branding and
   light customization.</dd>

<dt>recognitionLanguage</dt>
  <dd>a 2 character language codes based on:
      http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt
      If set, this is used to determine the language that should be used
      when processing images and PDF files to find text.
      If not set, then the 'preferredLanguage' will be used.
  </dd>

<dt>educationalInstitution</dt>
  <dd>a flag indicating that the user is part of an educational institution which
  makes them eligible for discounts on bulk purchases
  </dd>

<dt>businessAddress</dt>
  <dd>A string recording the business address of a Sponsored Account user who has requested invoicing.
  </dd>

<dt>hideSponsorBilling</dt>
  <dd>A flag indicating whether to hide the billing information on a sponsored
      account owner's settings page
  </dd>

<dt>taxExempt</dt>
  <dd>A flag indicating the user's sponsored group is exempt from sale tax
  </dd>

<dt>useEmailAutoFiling</dt>
  <dd>A flag indicating whether the user chooses to allow Evernote to automatically
      file and tag emailed notes
  </dd>

<dt>reminderEmailConfig</dt>
  <dd>Configuration state for whether or not the user wishes to receive
      reminder e-mail.  This setting applies to both the reminder e-mail sent
      for personal reminder notes and for the reminder e-mail sent for reminder
      notes in the user's business notebooks that the user has configured for
      e-mail notifications.
  </dd>
</dl>

Constant Summary collapse

DEFAULTLOCATIONNAME =

DEFAULTLATITUDE =

DEFAULTLONGITUDE =

PREACTIVATION =

VIEWEDPROMOTIONS =

INCOMINGEMAILADDRESS =

RECENTMAILEDADDRESSES =

COMMENTS =

DATEAGREEDTOTERMSOFSERVICE =

MAXREFERRALS =

REFERRALCOUNT =

REFERERCODE =

SENTEMAILDATE =

SENTEMAILCOUNT =

DAILYEMAILLIMIT =

EMAILOPTOUTDATE =

PARTNEREMAILOPTINDATE =

PREFERREDLANGUAGE =

PREFERREDCOUNTRY =

CLIPFULLPAGE =

TWITTERUSERNAME =

TWITTERID =

GROUPNAME =

RECOGNITIONLANGUAGE =

REFERRALPROOF =

EDUCATIONALDISCOUNT =

BUSINESSADDRESS =

HIDESPONSORBILLING =

TAXEXEMPT =

USEEMAILAUTOFILING =

REMINDEREMAILCONFIG =

FIELDS =

{
  DEFAULTLOCATIONNAME => {:type => ::Thrift::Types::STRING, :name => 'defaultLocationName', :optional => true},
  DEFAULTLATITUDE => {:type => ::Thrift::Types::DOUBLE, :name => 'defaultLatitude', :optional => true},
  DEFAULTLONGITUDE => {:type => ::Thrift::Types::DOUBLE, :name => 'defaultLongitude', :optional => true},
  PREACTIVATION => {:type => ::Thrift::Types::BOOL, :name => 'preactivation', :optional => true},
  VIEWEDPROMOTIONS => {:type => ::Thrift::Types::LIST, :name => 'viewedPromotions', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
  INCOMINGEMAILADDRESS => {:type => ::Thrift::Types::STRING, :name => 'incomingEmailAddress', :optional => true},
  RECENTMAILEDADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'recentMailedAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
  COMMENTS => {:type => ::Thrift::Types::STRING, :name => 'comments', :optional => true},
  DATEAGREEDTOTERMSOFSERVICE => {:type => ::Thrift::Types::I64, :name => 'dateAgreedToTermsOfService', :optional => true},
  MAXREFERRALS => {:type => ::Thrift::Types::I32, :name => 'maxReferrals', :optional => true},
  REFERRALCOUNT => {:type => ::Thrift::Types::I32, :name => 'referralCount', :optional => true},
  REFERERCODE => {:type => ::Thrift::Types::STRING, :name => 'refererCode', :optional => true},
  SENTEMAILDATE => {:type => ::Thrift::Types::I64, :name => 'sentEmailDate', :optional => true},
  SENTEMAILCOUNT => {:type => ::Thrift::Types::I32, :name => 'sentEmailCount', :optional => true},
  DAILYEMAILLIMIT => {:type => ::Thrift::Types::I32, :name => 'dailyEmailLimit', :optional => true},
  EMAILOPTOUTDATE => {:type => ::Thrift::Types::I64, :name => 'emailOptOutDate', :optional => true},
  PARTNEREMAILOPTINDATE => {:type => ::Thrift::Types::I64, :name => 'partnerEmailOptInDate', :optional => true},
  PREFERREDLANGUAGE => {:type => ::Thrift::Types::STRING, :name => 'preferredLanguage', :optional => true},
  PREFERREDCOUNTRY => {:type => ::Thrift::Types::STRING, :name => 'preferredCountry', :optional => true},
  CLIPFULLPAGE => {:type => ::Thrift::Types::BOOL, :name => 'clipFullPage', :optional => true},
  TWITTERUSERNAME => {:type => ::Thrift::Types::STRING, :name => 'twitterUserName', :optional => true},
  TWITTERID => {:type => ::Thrift::Types::STRING, :name => 'twitterId', :optional => true},
  GROUPNAME => {:type => ::Thrift::Types::STRING, :name => 'groupName', :optional => true},
  RECOGNITIONLANGUAGE => {:type => ::Thrift::Types::STRING, :name => 'recognitionLanguage', :optional => true},
  REFERRALPROOF => {:type => ::Thrift::Types::STRING, :name => 'referralProof', :optional => true},
  EDUCATIONALDISCOUNT => {:type => ::Thrift::Types::BOOL, :name => 'educationalDiscount', :optional => true},
  BUSINESSADDRESS => {:type => ::Thrift::Types::STRING, :name => 'businessAddress', :optional => true},
  HIDESPONSORBILLING => {:type => ::Thrift::Types::BOOL, :name => 'hideSponsorBilling', :optional => true},
  TAXEXEMPT => {:type => ::Thrift::Types::BOOL, :name => 'taxExempt', :optional => true},
  USEEMAILAUTOFILING => {:type => ::Thrift::Types::BOOL, :name => 'useEmailAutoFiling', :optional => true},
  REMINDEREMAILCONFIG => {:type => ::Thrift::Types::I32, :name => 'reminderEmailConfig', :optional => true, :enum_class => ::Evernote::EDAM::Type::ReminderEmailConfig}
}

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`

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

#validate ⇒ `Object`

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

def validate
  unless @reminderEmailConfig.nil? || ::Evernote::EDAM::Type::ReminderEmailConfig::VALID_VALUES.include?(@reminderEmailConfig)
    raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field reminderEmailConfig!')
  end
end