![]() |
SDK
2.1.4 [async]
CloudBackend Software Development Kit - SDK API for C++
|
Login account information. More...
#include <Account.h>
Public Member Functions | |
cbe::UserId | userId () const |
Returns the account id of the user. | |
std::string | username () const |
Returns the username of the account. More... | |
std::string | password () const |
Returns the password of the account. More... | |
std::string | source () const |
Returns the tenant name of the account. More... | |
std::string | client () const |
Returns the client of the account. More... | |
std::string | firstName () const |
Returns the given name of the user. More... | |
std::string | lastName () const |
Returns the surname of the user. | |
cbe::Container | rootContainer () const |
Returns the rootContainer for the account. More... | |
cbe::ContainerId | tenantContainerId () const |
Returns the tenant ContainerId. More... | |
cbe::ContainerId | libContainerId () const |
Returns the library ContainerId. More... | |
cbe::DatabaseId | rootDatabase () const |
Returns the DatabaseId for home://. More... | |
cbe::DataBases | databases () const |
Returns the Databases available. More... | |
Account (cbe::DefaultCtor) | |
Default constructor. More... | |
operator bool () const | |
Checks if the current instance is real. More... | |
Friends | |
class | CloudBackend |
Login account information.
cbe::Account::Account | ( | cbe::DefaultCtor | ) |
Default constructor.
Construct a new object with the DefaultCtor
to enable the operator bool() test
std::string cbe::Account::client | ( | ) | const |
Returns the client of the account.
If it was set when the account was created.
cbe::DataBases cbe::Account::databases | ( | ) | const |
Returns the Databases available.
Returns a std::map of databases available for the account.
std::string cbe::Account::firstName | ( | ) | const |
Returns the given name of the user.
Stored in lowercase.
cbe::ContainerId cbe::Account::libContainerId | ( | ) | const |
Returns the library ContainerId.
The ContainerId of the library database for the account, which is where application specific settings and application state can be permanently stored in order to be available next time the app starts.
|
explicit |
Checks if the current instance is real.
An "unreal" instance implies typically a failed event.
Relies on the Default
constructor
Account(cbe::DefaultCtor)
true
: is real false
: unreal; got nullptr; if current instance is unbound/undefined. I.e., if it is only default constructed. std::string cbe::Account::password | ( | ) | const |
Returns the password of the account.
What was used to login.
cbe::Container cbe::Account::rootContainer | ( | ) | const |
Returns the rootContainer for the account.
The top container is also known as home://
cbe::DatabaseId cbe::Account::rootDatabase | ( | ) | const |
Returns the DatabaseId for home://.
Returns the databaseId for root a.k.a. home:// of the account.
std::string cbe::Account::source | ( | ) | const |
Returns the tenant name of the account.
cbe::ContainerId cbe::Account::tenantContainerId | ( | ) | const |
std::string cbe::Account::username | ( | ) | const |
Returns the username of the account.
Stored in lowercase.