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

#include <Types.h>

Inheritance diagram for qevercloud::UserAttributes:
qevercloud::Printable

Public Member Functions

virtual void print (QTextStream &strm) const override
 
bool operator== (const UserAttributes &other) const
 
bool operator!= (const UserAttributes &other) const
 
- Public Member Functions inherited from qevercloud::Printable
 Printable ()=default
 
virtual ~Printable ()=default
 
virtual QString toString () const
 

Public Attributes

EverCloudLocalData localData
 
Optional< QString > defaultLocationName
 
Optional< double > defaultLatitude
 
Optional< double > defaultLongitude
 
Optional< bool > preactivation
 
Optional< QStringList > viewedPromotions
 
Optional< QString > incomingEmailAddress
 
Optional< QStringList > recentMailedAddresses
 
Optional< QString > comments
 
Optional< TimestampdateAgreedToTermsOfService
 
Optional< qint32 > maxReferrals
 
Optional< qint32 > referralCount
 
Optional< QString > refererCode
 
Optional< TimestampsentEmailDate
 
Optional< qint32 > sentEmailCount
 
Optional< qint32 > dailyEmailLimit
 
Optional< TimestampemailOptOutDate
 
Optional< TimestamppartnerEmailOptInDate
 
Optional< QString > preferredLanguage
 
Optional< QString > preferredCountry
 
Optional< bool > clipFullPage
 
Optional< QString > twitterUserName
 
Optional< QString > twitterId
 
Optional< QString > groupName
 
Optional< QString > recognitionLanguage
 
Optional< QString > referralProof
 
Optional< bool > educationalDiscount
 
Optional< QString > businessAddress
 
Optional< bool > hideSponsorBilling
 
Optional< bool > useEmailAutoFiling
 
Optional< ReminderEmailConfigreminderEmailConfig
 
Optional< TimestampemailAddressLastConfirmed
 
Optional< TimestamppasswordUpdated
 
Optional< bool > salesforcePushEnabled
 
Optional< bool > shouldLogClientEvent
 
Optional< bool > optOutMachineLearning
 

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 Function Documentation

◆ operator!=()

bool qevercloud::UserAttributes::operator!= ( const UserAttributes other) const
inline

◆ operator==()

bool qevercloud::UserAttributes::operator== ( const UserAttributes other) const
inline

◆ print()

virtual void qevercloud::UserAttributes::print ( QTextStream &  strm) const
overridevirtual

Implements qevercloud::Printable.

Member Data Documentation

◆ businessAddress

Optional< QString > qevercloud::UserAttributes::businessAddress

A string recording the business address of a Sponsored Account user who has requested invoicing.

◆ clipFullPage

Optional< bool > qevercloud::UserAttributes::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.

◆ comments

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

◆ dailyEmailLimit

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.

◆ dateAgreedToTermsOfService

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.

◆ defaultLatitude

Optional< double > qevercloud::UserAttributes::defaultLatitude

if set, this is the latitude that should be assigned to any notes that have no other latitude information.

◆ defaultLocationName

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

◆ defaultLongitude

Optional< double > qevercloud::UserAttributes::defaultLongitude

if set, this is the longitude that should be assigned to any notes that have no other longitude information.

◆ educationalDiscount

Optional< bool > qevercloud::UserAttributes::educationalDiscount

NOT DOCUMENTED

◆ emailAddressLastConfirmed

Optional< Timestamp > qevercloud::UserAttributes::emailAddressLastConfirmed

If set, this contains the time at which the user last confirmed that the configured email address for this account is correct and up-to-date. If this is unset that indicates that the user's email address is unverified.

◆ emailOptOutDate

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.

◆ groupName

Optional< QString > qevercloud::UserAttributes::groupName

A name identifier used to identify a particular set of branding and light customization.

◆ hideSponsorBilling

Optional< bool > qevercloud::UserAttributes::hideSponsorBilling

A flag indicating whether to hide the billing information on a sponsored account owner's settings page

◆ incomingEmailAddress

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

◆ localData

EverCloudLocalData qevercloud::UserAttributes::localData

See the declaration of EverCloudLocalData for details

◆ maxReferrals

Optional< qint32 > qevercloud::UserAttributes::maxReferrals

The number of referrals that the user is permitted to make.

◆ optOutMachineLearning

Optional< bool > qevercloud::UserAttributes::optOutMachineLearning

If set to True, no Machine Learning nor human review will be done to this user's note contents.

◆ partnerEmailOptInDate

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.

◆ passwordUpdated

Optional< Timestamp > qevercloud::UserAttributes::passwordUpdated

If set, this contains the time at which the user's password last changed. This will be unset for users created before the addition of this field who have not changed their passwords since the addition of this field.

◆ preactivation

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.

◆ preferredCountry

Optional< QString > qevercloud::UserAttributes::preferredCountry

Preferred country code based on ISO 3166-1-alpha-2 indicating the users preferred country

◆ preferredLanguage

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

◆ recentMailedAddresses

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

◆ recognitionLanguage

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.

◆ refererCode

Optional< QString > qevercloud::UserAttributes::refererCode

A code indicating where the user was sent from. AKA promotion code

◆ referralCount

Optional< qint32 > qevercloud::UserAttributes::referralCount

The number of referrals sent from this account.

◆ referralProof

Optional< QString > qevercloud::UserAttributes::referralProof

NOT DOCUMENTED

◆ reminderEmailConfig

Optional< ReminderEmailConfig > 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.

◆ salesforcePushEnabled

Optional< bool > qevercloud::UserAttributes::salesforcePushEnabled

NOT DOCUMENTED

◆ sentEmailCount

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.

◆ sentEmailDate

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.

◆ shouldLogClientEvent

Optional< bool > qevercloud::UserAttributes::shouldLogClientEvent

If set to True, the server will record LogRequest send from clients of this user as ClientEventLog.

◆ twitterId

Optional< QString > qevercloud::UserAttributes::twitterId

The unique identifier of the user's Twitter account if that user has chosen to enable Twittering into Evernote.

◆ twitterUserName

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.

◆ useEmailAutoFiling

Optional< bool > qevercloud::UserAttributes::useEmailAutoFiling

A flag indicating whether the user chooses to allow Evernote to automatically file and tag emailed notes

◆ viewedPromotions

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