qevercloud::User Struct Reference

#include <types.h>

Public Member Functions
bool	operator== (const User &other) const
bool	operator!= (const User &other) const

Public Attributes
Optional< UserID >	id
Optional< QString >	username
Optional< QString >	email
Optional< QString >	name
Optional< QString >	timezone
Optional< PrivilegeLevel::type >	privilege
Optional< Timestamp >	created
Optional< Timestamp >	updated
Optional< Timestamp >	deleted
Optional< bool >	active
Optional< QString >	shardId
Optional< UserAttributes >	attributes
Optional< Accounting >	accounting
Optional< PremiumInfo >	premiumInfo
Optional< BusinessUserInfo >	businessUserInfo

Detailed Description

This represents the information about a single user account.

Member Function Documentation

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

inline

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

inline

Member Data Documentation

Optional< Accounting > qevercloud::User::accounting

Bookkeeping information for the user's subscription.

Optional< bool > qevercloud::User::active

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

Optional< UserAttributes > qevercloud::User::attributes

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

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.

Optional< Timestamp > qevercloud::User::created

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

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.

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

Optional< UserID > qevercloud::User::id

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

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

Optional< PremiumInfo > qevercloud::User::premiumInfo

If present, this will contain a set of commerce information relating to the user's premium service level.

Optional< PrivilegeLevel::type > qevercloud::User::privilege

The level of access permitted for the user.

Optional< QString > qevercloud::User::shardId

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

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

Optional< Timestamp > qevercloud::User::updated

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

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