Equinox/com.tecknobit.equinox.environment.records/EquinoxLocalUser

Equinox Local User

abstract class EquinoxLocalUser

The EquinoxLocalUser class is useful to represent a user in the client application

Author

N7ghtm4r3 - Tecknobit

Since

1.0.1

Constructors

EquinoxLocalUser

constructor()

Properties

protected open var email: String

email the email of the user

protected open var hostAddress: String

hostAddress the host address which the user communicate

protected open var language: String

language the language of the user

protected open var name: String

name the name of the user

protected open var password: String

password the password of the user

protected open var profilePic: String

profilePic the profile pick of the user

protected open var surname: String

surname the surname of the user

protected open var theme: EquinoxUser.ApplicationTheme

theme the theme of the user

protected open var userId: String

userId the identifier of the user

protected open var userToken: String

userToken the token of the user

Functions

abstract fun clear()

Method to clear the current local user session No-any params required

getCompleteName

open fun getCompleteName(): String

Method to get the complete name of the user No-any params required

open fun getEmail(): String

Method to get email instance No-any params required

open fun getHostAddress(): String

Method to get hostAddress instance No-any params required

open fun getLanguage(): String

Method to get language instance No-any params required

open fun getName(): String

Method to get name instance No-any params required

open fun getPassword(): String

Method to get password instance No-any params required

protected abstract fun getPreference(key: String): String

Method to get a stored preference

open fun getProfilePic(): String

Method to get profilePic instance No-any params required

open fun getSurname(): String

Method to get surname instance No-any params required

open fun getTheme(): EquinoxUser.ApplicationTheme

Method to get theme instance No-any params required

open fun getUserId(): String

Method to get userId instance No-any params required

open fun getUserToken(): String

Method to get userToken instance No-any params required

protected open fun initLocalUser()

Method to init the local user session No-any params required

open fun insertNewUser(hostAddress: String, name: String, surname: String, email: String, password: String, language: String, hResponse: JsonHelper, custom: Array<Any>)

Method to insert and init a new local user

isAuthenticated

open fun isAuthenticated(): Boolean

Method to get whether the user is already authenticated in a session No-any params required

open fun setEmail(email: String)

Method to set the email instance

open fun setHostAddress(hostAddress: String)

Method to set the hostAddress instance

open fun setLanguage(language: String)

Method to set the language instance

open fun setName(name: String)

Method to set the name instance

open fun setPassword(password: String)

Method to set the password instance

protected abstract fun setPreference(key: String, value: String)

Method to store and set a preference

open fun setProfilePic(profilePic: String)

Method to set the profilePic instance

open fun setSurname(surname: String)

Method to set the surname instance

open fun setTheme(theme: EquinoxUser.ApplicationTheme)

Method to set the theme instance

open fun setUserId(userId: String)

Method to set the userId instance

open fun setUserToken(userToken: String)

Method to set the userToken instance