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

#include <Types.h>

Inheritance diagram for qevercloud::User:
qevercloud::Printable

Public Member Functions

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

Public Attributes

EverCloudLocalData localData
 
Optional< UserIDid
 
Optional< QString > username
 
Optional< QString > email
 
Optional< QString > name
 
Optional< QString > timezone
 
Optional< PrivilegeLevelprivilege
 
Optional< ServiceLevelserviceLevel
 
Optional< Timestampcreated
 
Optional< Timestampupdated
 
Optional< Timestampdeleted
 
Optional< bool > active
 
Optional< QString > shardId
 
Optional< UserAttributesattributes
 
Optional< Accountingaccounting
 
Optional< BusinessUserInfobusinessUserInfo
 
Optional< QString > photoUrl
 
Optional< TimestampphotoLastUpdated
 
Optional< AccountLimitsaccountLimits
 

Detailed Description

This represents the information about a single user account.

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

◆ print()

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

Implements qevercloud::Printable.

Member Data Documentation

◆ accounting

Optional< Accounting > qevercloud::User::accounting

Bookkeeping information for the user's subscription.

◆ accountLimits

Optional< AccountLimits > qevercloud::User::accountLimits

Account limits applicable for this user.

◆ active

Optional< bool > qevercloud::User::active

If the user account is available for login and synchronization, this flag will be set to true.

◆ attributes

Optional< UserAttributes > qevercloud::User::attributes

If present, this will contain a list of the attributes for this user account.

◆ businessUserInfo

Optional< BusinessUserInfo > qevercloud::User::businessUserInfo

If present, this will contain a set of business information relating to the user's business membership. If not present, the user is not currently part of a business.

◆ created

Optional< Timestamp > qevercloud::User::created

The date and time when this user account was created in the service.

◆ deleted

Optional< Timestamp > qevercloud::User::deleted

If the account has been deleted from the system (e.g. as the result of a legal request by the user), the date and time of the deletion will be represented here. If not, this value will not be set.

◆ email

Optional< QString > qevercloud::User::email

The email address registered for the user. Must comply with RFC 2821 and RFC 2822.
Third party applications that authenticate using OAuth do not have access to this field. Length: EDAM_EMAIL_LEN_MIN - EDAM_EMAIL_LEN_MAX
Regex: EDAM_EMAIL_REGEX

◆ id

Optional< UserID > qevercloud::User::id

The unique numeric identifier for the account, which will not change for the lifetime of the account.

◆ localData

EverCloudLocalData qevercloud::User::localData

See the declaration of EverCloudLocalData for details

◆ name

Optional< QString > qevercloud::User::name

The printable name of the user, which may be a combination of given and family names. This is used instead of separate "first" and "last" names due to variations in international name format/order. May not start or end with a whitespace character. May contain any character but carriage return or newline (Unicode classes Zl and Zp).
Length: EDAM_USER_NAME_LEN_MIN - EDAM_USER_NAME_LEN_MAX
Regex: EDAM_USER_NAME_REGEX

◆ photoLastUpdated

Optional< Timestamp > qevercloud::User::photoLastUpdated

The time at which the photo at 'photoUrl' was last updated by this User. This field will be null if the User never set a profile photo. This field is filled in by the service and is read-only to clients.

◆ photoUrl

Optional< QString > qevercloud::User::photoUrl

The URL of the photo that represents this User. This field is filled in by the service and is read-only to clients. If photoLastUpdated is not set, this url will point to a placeholder user photo generated by the service.

◆ privilege

Optional< PrivilegeLevel > qevercloud::User::privilege

NOT DOCUMENTED

◆ serviceLevel

Optional< ServiceLevel > qevercloud::User::serviceLevel

The level of service the user currently receives. This will always be populated for users retrieved from the Evernote service.

◆ shardId

Optional< QString > qevercloud::User::shardId

DEPRECATED - Client applications should have no need to use this field.

◆ timezone

Optional< QString > qevercloud::User::timezone

The zone ID for the user's default location. If present, this may be used to localize the display of any timestamp for which no other timezone is available. The format must be encoded as a standard zone ID such as "America/Los_Angeles" or "GMT+08:00"
Length: EDAM_TIMEZONE_LEN_MIN - EDAM_TIMEZONE_LEN_MAX
Regex: EDAM_TIMEZONE_REGEX

◆ updated

Optional< Timestamp > qevercloud::User::updated

The date and time when this user account was last modified in the service.

◆ username

Optional< QString > qevercloud::User::username

The name that uniquely identifies a single user account. This name may be presented by the user, along with their password, to log into their account. May only contain a-z, 0-9, or '-', and may not start or end with the '-'
Length: EDAM_USER_USERNAME_LEN_MIN - EDAM_USER_USERNAME_LEN_MAX
Regex: EDAM_USER_USERNAME_REGEX