#include <albaUser.h>
Public Member Functions | |
| albaUser () | |
| virtual | ~albaUser () |
| int | ShowLoginDialog () |
| virtual bool | CheckUserCredentials () |
| virtual bool | IsAuthenticated () |
| bool | SetCredentials (albaString &name, albaString &pwd, int &proxyFlag, albaString &proxyHost, albaString &proxyPort, int &remember_me) |
| albaString & | GetName () |
| albaString & | GetPwd () |
| albaString & | GetProxyHost () |
| int & | GetProxyPort () |
| int & | GetProxyFlag () |
| int | GetRememberUserCredentials () |
Protected Member Functions | |
| void | InitializeUserInformations () |
| void | UpdateUserCredentialsFile () |
| void | InitUserInfoHome () |
Protected Attributes | |
| albaString | m_Username |
| albaString | m_Password |
| albaString | m_ProxyHost |
| int | m_ProxyFlag |
| int | m_ProxyPort |
| albaString | m_UserHome |
| albaString | m_UserInfoFile |
| int | m_RememberCredentials |
| bool | m_Initialized |
Detailed Description
albaUser - Used to manage username and password; store them and give basic function to check user's credentials.
This is intended as starting point for user managing. Method for Check User Credentials can be redefined to be customized at application level according to custom requests.
Definition at line 32 of file albaUser.h.
Constructor & Destructor Documentation
◆ albaUser()
| albaUser::albaUser | ( | ) |
◆ ~albaUser()
|
virtual |
Member Function Documentation
◆ ShowLoginDialog()
| int albaUser::ShowLoginDialog | ( | ) |
Allows to show login dialog and get credentials from the application's user.
◆ CheckUserCredentials()
|
virtual |
Function to be customized at application level.
By default open Login Dialog if the user did not inserted any information.
◆ IsAuthenticated()
|
virtual |
Function to be customized at application level.
Must return true if user is authenticated
◆ SetCredentials()
| bool albaUser::SetCredentials | ( | albaString & | name, |
| albaString & | pwd, | ||
| int & | proxyFlag, | ||
| albaString & | proxyHost, | ||
| albaString & | proxyPort, | ||
| int & | remember_me | ||
| ) |
Set the user's credentials.
Return 'true' if the users' credentials are correctly initialized, otherwise 'flase' value is returned.
◆ GetName()
| albaString & albaUser::GetName | ( | ) |
Return the information on user name.
◆ GetPwd()
| albaString & albaUser::GetPwd | ( | ) |
Return the information on users' password.
◆ GetProxyHost()
| albaString & albaUser::GetProxyHost | ( | ) |
Return the information on proxy host.
◆ GetProxyPort()
| int & albaUser::GetProxyPort | ( | ) |
Return the information on proxy port.
◆ GetProxyFlag()
| int & albaUser::GetProxyFlag | ( | ) |
Return the information on proxy flag.
◆ GetRememberUserCredentials()
| int albaUser::GetRememberUserCredentials | ( | ) |
Return information to allow saving or not users' information.
◆ InitializeUserInformations()
|
protected |
Retrieve user information saved into an encrypted file.
◆ UpdateUserCredentialsFile()
|
protected |
Update user credentials into an encrypted file or remove the file if the user don't want to save its credentials.
◆ InitUserInfoHome()
|
protected |
Set the folder in which store encrypted user credentials.
Member Data Documentation
◆ m_Username
|
protected |
Definition at line 83 of file albaUser.h.
◆ m_Password
|
protected |
Definition at line 84 of file albaUser.h.
◆ m_ProxyHost
|
protected |
Proxy Host.
Definition at line 85 of file albaUser.h.
◆ m_ProxyFlag
|
protected |
Flag used to for enable proxy.
Definition at line 86 of file albaUser.h.
◆ m_ProxyPort
|
protected |
Proxy Host.
Definition at line 87 of file albaUser.h.
◆ m_UserHome
|
protected |
Definition at line 88 of file albaUser.h.
◆ m_UserInfoFile
|
protected |
Definition at line 89 of file albaUser.h.
◆ m_RememberCredentials
|
protected |
Definition at line 90 of file albaUser.h.
◆ m_Initialized
|
protected |
Flag used to verify if users' information has been initialized.
Definition at line 91 of file albaUser.h.
The documentation for this class was generated from the following file:
