Class that encapsulates information about a license user. More...

#include <LicenseSpring/LicenseUser.h>

Public Types
using	ptr_t = std::shared_ptr< LicenseUser >

Public Member Functions
	LicenseUser ()
	Constructs a license user with no information. More...

	LicenseUser (bool isActive, bool isInitialPassword, uint64_t id, const std::string &email, const std::string &firstName, const std::string &lastName, const std::string &phoneNumber=std::string(), const std::string &initialPassword=std::string(), uint64_t licenseId=0, uint64_t orderId=0, const std::string &orderStoreId=std::string())
	Constructs a license user with given information. More...

bool	isActive () const
	Getter method for user status (active/inactive). More...

bool	isInitialPassword () const
	Getter method for password status, has it been changed by user or not. More...

uint64_t	id () const
	Getter method for user id. More...

const std::string &	email () const
	Getter method for user email. More...

const std::string &	firstName () const
	Getter method for user first name. More...

const std::string &	lastName () const
	Getter method for user last name. More...

const std::string &	phoneNumber () const
	Getter method for user phone number. More...

const std::string &	initialPassword () const
	Getter method for user initial password. More...

uint64_t	licenseId () const
	Getter method for license internal identifier. More...

uint64_t	orderId () const
	Getter method for order internal identifier. More...

const std::string &	orderStoreId () const
	Getter method for order store id. More...

Detailed Description

Class that encapsulates information about a license user.

Used to hold information for user-based licenses.

Definition at line 18 of file LicenseUser.h.

Member Typedef Documentation

◆ ptr_t

using LicenseSpring::LicenseUser::ptr_t = std::shared_ptr<LicenseUser>

Definition at line 21 of file LicenseUser.h.

Constructor & Destructor Documentation

◆ LicenseUser() [1/2]

LicenseSpring::LicenseUser::LicenseUser ( )

Constructs a license user with no information.

◆ LicenseUser() [2/2]

LicenseSpring::LicenseUser::LicenseUser	(	bool	isActive,
		bool	isInitialPassword,
		uint64_t	id,
		const std::string &	email,
		const std::string &	firstName,
		const std::string &	lastName,
		const std::string &	phoneNumber = `std::string()`,
		const std::string &	initialPassword = `std::string()`,
		uint64_t	licenseId = `0`,
		uint64_t	orderId = `0`,
		const std::string &	orderStoreId = `std::string()`
	)

Constructs a license user with given information.

Parameters

isActive	Boolean for whether user license is active
isInitialPassword	Boolean for whether user uses initial password still
id	User ID
email	User email
firstName	User first name
lastName	User last name
phoneNumber	User phone number
initialPassword	User initial password
licenseId	User license ID
orderId	Order ID of user
orderStoreId	Order store ID

Member Function Documentation

◆ isActive()

bool LicenseSpring::LicenseUser::isActive ( ) const

Getter method for user status (active/inactive).

Returns: User status.

◆ isInitialPassword()

bool LicenseSpring::LicenseUser::isInitialPassword ( ) const

Getter method for password status, has it been changed by user or not.

Returns: Password status.

◆ id()

uint64_t LicenseSpring::LicenseUser::id ( ) const

Getter method for user id.

Returns: User id.

◆ email()

const std::string& LicenseSpring::LicenseUser::email ( ) const

Getter method for user email.

Returns: User email.

◆ firstName()

const std::string& LicenseSpring::LicenseUser::firstName ( ) const

Getter method for user first name.

Returns: User first name.

◆ lastName()

const std::string& LicenseSpring::LicenseUser::lastName ( ) const

Getter method for user last name.

Returns: User last name.

◆ phoneNumber()

const std::string& LicenseSpring::LicenseUser::phoneNumber ( ) const

Getter method for user phone number.

Returns: User phone number.

◆ initialPassword()

const std::string& LicenseSpring::LicenseUser::initialPassword ( ) const

Getter method for user initial password.

It may be empty string if user changed the password.

Returns: User initial password.

◆ licenseId()

uint64_t LicenseSpring::LicenseUser::licenseId ( ) const

Getter method for license internal identifier.

Do not confuse this id with LicenseID. It is license id in the DB.

Returns: User license id.

◆ orderId()

uint64_t LicenseSpring::LicenseUser::orderId ( ) const

Getter method for order internal identifier.

Returns: Order id.

◆ orderStoreId()

const std::string& LicenseSpring::LicenseUser::orderStoreId ( ) const

Getter method for order store id.

Returns: Order store id.

The documentation for this class was generated from the following file:

LicenseSpring/LicenseUser.h

Public Types

Public Member Functions