![]() |
LicenseSpring C++ SDK 7.31.0
Easily add Software Licensing to your application
|
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. | |
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. | |
bool | isActive () const |
Getter method for user status (active/inactive). | |
bool | isInitialPassword () const |
Getter method for password status, has it been changed by user or not. | |
uint64_t | id () const |
Getter method for user id. | |
const std::string & | email () const |
Getter method for user email. | |
const std::string & | firstName () const |
Getter method for user first name. | |
const std::string & | lastName () const |
Getter method for user last name. | |
const std::string & | phoneNumber () const |
Getter method for user phone number. | |
const std::string & | initialPassword () const |
Getter method for user initial password. | |
uint64_t | licenseId () const |
Getter method for license internal identifier. | |
uint64_t | orderId () const |
Getter method for order internal identifier. | |
const std::string & | orderStoreId () const |
Getter method for order store id. | |
Class that encapsulates information about a license user.
Used to hold information for user-based licenses.
Definition at line 18 of file LicenseUser.h.
using LicenseSpring::LicenseUser::ptr_t = std::shared_ptr<LicenseUser> |
Definition at line 21 of file LicenseUser.h.
LicenseSpring::LicenseUser::LicenseUser | ( | ) |
Constructs a license user with no information.
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.
isActive | Boolean for whether user license is active |
isInitialPassword | Boolean for whether user uses initial password still |
id | User ID |
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 |
bool LicenseSpring::LicenseUser::isActive | ( | ) | const |
Getter method for user status (active/inactive).
bool LicenseSpring::LicenseUser::isInitialPassword | ( | ) | const |
Getter method for password status, has it been changed by user or not.
uint64_t LicenseSpring::LicenseUser::id | ( | ) | const |
Getter method for user id.
const std::string & LicenseSpring::LicenseUser::email | ( | ) | const |
Getter method for user email.
const std::string & LicenseSpring::LicenseUser::firstName | ( | ) | const |
Getter method for user first name.
const std::string & LicenseSpring::LicenseUser::lastName | ( | ) | const |
Getter method for user last name.
const std::string & LicenseSpring::LicenseUser::phoneNumber | ( | ) | const |
Getter method for user phone number.
const std::string & LicenseSpring::LicenseUser::initialPassword | ( | ) | const |
Getter method for user initial password.
It may be empty string if user changed the password.
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.
uint64_t LicenseSpring::LicenseUser::orderId | ( | ) | const |
Getter method for order internal identifier.
const std::string & LicenseSpring::LicenseUser::orderStoreId | ( | ) | const |
Getter method for order store id.