QEverCloud
Unofficial Evernote Cloud API for Qt
Public Member Functions | Public Attributes | List of all members
qevercloud::UserAttributes Struct Reference

A structure holding the optional attributes that can be stored on a User. More...

Public Member Functions

bool operator!= (const UserAttributes &other) const
 
bool operator== (const UserAttributes &other) const
 

Public Attributes

Optional< QString > businessAddress
 A string recording the business address of a Sponsored Account user who has requested invoicing.
 
Optional< bool > clipFullPage
 Boolean flag set to true if the user wants to clip full pages by default when they use the web clipper without a selection.
 
Optional< QString > comments
 Free-form text field that may hold general support information, etc. More...
 
Optional< qint32 > dailyEmailLimit
 If set, this is the maximum number of emails that may be sent in a given day from this account. More...
 
Optional< TimestampdateAgreedToTermsOfService
 The date/time when the user agreed to the terms of service. More...
 
Optional< double > defaultLatitude
 if set, this is the latitude that should be assigned to any notes that have no other latitude information.
 
Optional< QString > defaultLocationName
 the location string that should be associated with the user in order to determine where notes are taken if not otherwise specified. More...
 
Optional< double > defaultLongitude
 if set, this is the longitude that should be assigned to any notes that have no other longitude information.
 
Optional< bool > educationalDiscount
 NOT DOCUMENTED.
 
Optional< TimestampemailOptOutDate
 If set, this is the date when the user asked to be excluded from offers and promotions sent by Evernote. More...
 
Optional< QString > groupName
 A name identifier used to identify a particular set of branding and light customization.
 
Optional< bool > hideSponsorBilling
 A flag indicating whether to hide the billing information on a sponsored account owner's settings page.
 
Optional< QString > incomingEmailAddress
 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. More...
 
Optional< qint32 > maxReferrals
 The number of referrals that the user is permitted to make.
 
Optional< TimestamppartnerEmailOptInDate
 If set, this is the date when the user asked to be included in offers and promotions sent by Evernote's partners. More...
 
Optional< bool > preactivation
 if set, the user account is not yet confirmed for login. More...
 
Optional< QString > preferredCountry
 Preferred country code based on ISO 3166-1-alpha-2 indicating the users preferred country.
 
Optional< QString > preferredLanguage
 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. More...
 
Optional< QStringList > recentMailedAddresses
 if set, this will contain a list of email addresses that have recently been used as recipients of outbound emails by the user. More...
 
Optional< QString > recognitionLanguage
 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. More...
 
Optional< QString > refererCode
 A code indicating where the user was sent from. More...
 
Optional< qint32 > referralCount
 The number of referrals sent from this account.
 
Optional< QString > referralProof
 NOT DOCUMENTED.
 
Optional
< ReminderEmailConfig::type > 
reminderEmailConfig
 Configuration state for whether or not the user wishes to receive reminder e-mail. More...
 
Optional< qint32 > sentEmailCount
 The number of emails that were sent from the user via the service on sentEmailDate. More...
 
Optional< TimestampsentEmailDate
 The most recent date when the user sent outbound emails from the service. More...
 
Optional< bool > taxExempt
 A flag indicating the user's sponsored group is exempt from sale tax.
 
Optional< QString > twitterId
 The unique identifier of the user's Twitter account if that user has chosen to enable Twittering into Evernote.
 
Optional< QString > twitterUserName
 The username of the account of someone who has chosen to enable Twittering into Evernote. More...
 
Optional< bool > useEmailAutoFiling
 A flag indicating whether the user chooses to allow Evernote to automatically file and tag emailed notes.
 
Optional< QStringList > viewedPromotions
 a list of promotions the user has seen. More...
 

Detailed Description

A structure holding the optional attributes that can be stored on a User.

These are generally less critical than the core User fields.

Member Data Documentation

Optional< QString > qevercloud::UserAttributes::comments

Free-form text field that may hold general support information, etc.


Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

Optional< qint32 > qevercloud::UserAttributes::dailyEmailLimit

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.

Optional< Timestamp > qevercloud::UserAttributes::dateAgreedToTermsOfService

The date/time when the user agreed to the terms of service.

This can be used as the effective "start date" for the account.

Optional< QString > qevercloud::UserAttributes::defaultLocationName

the location string that should be associated with the user in order to determine where notes are taken if not otherwise specified.


Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

Optional< Timestamp > qevercloud::UserAttributes::emailOptOutDate

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.

Optional< QString > qevercloud::UserAttributes::incomingEmailAddress

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.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX

Optional< Timestamp > qevercloud::UserAttributes::partnerEmailOptInDate

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.

Optional< bool > qevercloud::UserAttributes::preactivation

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.

Optional< QString > qevercloud::UserAttributes::preferredLanguage

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).

Optional< QStringList > qevercloud::UserAttributes::recentMailedAddresses

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.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX each
Max: EDAM_USER_RECENT_MAILED_ADDRESSES_MAX entries

Optional< QString > qevercloud::UserAttributes::recognitionLanguage

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.

Optional< QString > qevercloud::UserAttributes::refererCode

A code indicating where the user was sent from.

AKA promotion code

Optional< ReminderEmailConfig::type > qevercloud::UserAttributes::reminderEmailConfig

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.

Optional< qint32 > qevercloud::UserAttributes::sentEmailCount

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.

Optional< Timestamp > qevercloud::UserAttributes::sentEmailDate

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.

Optional< QString > qevercloud::UserAttributes::twitterUserName

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.

Optional< QStringList > qevercloud::UserAttributes::viewedPromotions

a list of promotions the user has seen.

This list may occasionally be modified by the system when promotions are no longer available.
Length: EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX