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

Equinox User

@Entity

open class EquinoxUser : EquinoxItem

The EquinoxUser class is useful to represent a base Equinox's system user

Author

N7ghtm4r3 - Tecknobit

Since

1.0.1

Constructors

EquinoxUser

constructor()

Constructor to init the EquinoxUser class No-any params required

constructor(id: String, token: String, name: String, surname: String, email: String, password: String, language: String)

Constructor to init the EquinoxUser class

constructor(id: String, token: String, name: String, surname: String, email: String, password: String, profilePic: String, language: String, theme: EquinoxUser.ApplicationTheme)

Constructor to init the EquinoxUser class

constructor(jUser: JSONObject)

Constructor to init the EquinoxUser class

Types

ApplicationTheme

enum ApplicationTheme

ApplicationTheme list of the available theming for the client applications

Properties

DEFAULT_PROFILE_PIC

val DEFAULT_PROFILE_PIC: String = "profiles/defProfilePic.png"

DEFAULT_PROFILE_PIC the default profile pic path when the user has not set own image

DISCRIMINATOR_VALUE_KEY

val DISCRIMINATOR_VALUE_KEY: String = "dtype"

DISCRIMINATOR_VALUE_KEY the key for the "dtype" field

protected val email: String

email the email of the user

EMAIL_KEY

val EMAIL_KEY: String = "email"

EMAIL_KEY the key for the "email" field

hItem

protected val hItem: JsonHelper

hItem helper to work with JSON values

protected val id: String

id identifier of the item

IDENTIFIER_KEY

val IDENTIFIER_KEY: String = "id"

IDENTIFIER_KEY the key for the "id" field

language

protected val language: String

language the language of the user

LANGUAGE_KEY

val LANGUAGE_KEY: String = "language"

LANGUAGE_KEY the key for the "language" field

name

protected val name: String

name the name of the user

NAME_KEY

val NAME_KEY: String = "name"

NAME_KEY the key for the "name" field

password

protected val password: String

password the password of the user

PASSWORD_KEY

val PASSWORD_KEY: String = "password"

PASSWORD_KEY the key for the "password" field

PROFILE_PIC_KEY

val PROFILE_PIC_KEY: String = "profile_pic"

PROFILE_PIC_KEY the key for the "profile_pic" field

profilePic

protected val profilePic: String

profilePic the profile pic of the user

surname

protected val surname: String

surname the surname of the user

SURNAME_KEY

val SURNAME_KEY: String = "surname"

SURNAME_KEY the key for the "surname" field

theme

protected val theme: EquinoxUser.ApplicationTheme

theme the theme of the user

THEME_KEY

val THEME_KEY: String = "theme"

THEME_KEY the key for the "theme" field

timeFormatter

protected val timeFormatter: TimeFormatter

timeFormatter the formatter used to format the timestamp values

token

protected val token: String

token the token which the user is allowed to operate on server

TOKEN_KEY

val TOKEN_KEY: String = "token"

TOKEN_KEY the key for the "token" field

USERS_KEY

val USERS_KEY: String = "users"

USERS_KEY the key for the "users" field

Functions

getCompleteName

open fun getCompleteName(): String

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

getEmail

open fun getEmail(): String

Method to get email instance No-any params required

getId

open fun getId(): String

Method to get id instance No-any params required

getInstance

open fun getInstance(jUser: JSONObject): EquinoxUser

Method to assemble and return a EquinoxUser instance

getLanguage

open fun getLanguage(): String

Method to get language instance No-any params required

getName

open fun getName(): String

Method to get name instance No-any params required

getPassword

open fun getPassword(): String

Method to get password instance No-any params required

getProfilePic

open fun getProfilePic(): String

Method to get profilePic instance No-any params required

getSurname

open fun getSurname(): String

Method to get surname instance No-any params required

getTheme

open fun getTheme(): EquinoxUser.ApplicationTheme

Method to get name instance No-any params required

getToken

open fun getToken(): String

Method to get token instance No-any params required

getValidUserLanguage

open fun getValidUserLanguage(): String

Method to get a supported language for the user No-any params required

toString

open fun toString(): String

Equinox User

Author

Since

See also

Constructors

Types

Properties

Functions