core/com.tecknobit.ametistacore.models/AmetistaUser

Ametista User

@Entity

open class AmetistaUser : EquinoxUser, DTOConvertible<T>

The AmetistaUser class is useful to represent a base Ametista's system user

Author

N7ghtm4r3 - Tecknobit

Constructors

AmetistaUser

constructor()

Constructor to init the AmetistaUser class

constructor(id: String, token: String, name: String, surname: String, email: String, password: String, language: String, role: AmetistaUser.Role)

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, role: AmetistaUser.Role)

Constructor to init the EquinoxUser class

constructor(jUser: JSONObject)

Constructor to init the AmetistaUser class

Types

Role

enum Role

List of the available roles

Properties

ADMIN_CODE_KEY

val ADMIN_CODE_KEY: String = "admin_code"

ADMIN_CODE_KEY the key for the "admin_code" field

DEFAULT_PROFILE_PIC

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

DEFAULT_VIEWER_PASSWORD

val DEFAULT_VIEWER_PASSWORD: String = "changeme"

DEFAULT_VIEWER_PASSWORD the default password of a VIEWER just inserted

DISCRIMINATOR_VALUE_KEY

val DISCRIMINATOR_VALUE_KEY: String = "dtype"

protected val email: String

EMAIL_KEY

val EMAIL_KEY: String = "email"

hItem

protected val hItem: JsonHelper

protected val id: String

IDENTIFIER_KEY

val IDENTIFIER_KEY: String = "id"

IS_ADMIN_KEY

val IS_ADMIN_KEY: String = "is_admin"

IS_ADMIN_KEY the key for the "is_admin" field

language

protected val language: String

LANGUAGE_KEY

val LANGUAGE_KEY: String = "language"

MEMBERS_KEY

val MEMBERS_KEY: String = "members"

MEMBERS_KEY the key for the "members" field

name

protected val name: String

NAME_KEY

val NAME_KEY: String = "name"

password

protected val password: String

PASSWORD_KEY

val PASSWORD_KEY: String = "password"

PROFILE_PIC_KEY

val PROFILE_PIC_KEY: String = "profile_pic"

profilePic

protected val profilePic: String

role

val role: AmetistaUser.Role

role the role of the user

ROLE_KEY

val ROLE_KEY: String = "role"

ROLE_KEY the key for the "role" field

SESSION_KEY

val SESSION_KEY: String = "session"

SESSION_KEY the key for the "session" field

surname

protected val surname: String

SURNAME_KEY

val SURNAME_KEY: String = "surname"

theme

protected val theme: EquinoxUser.ApplicationTheme

THEME_KEY

val THEME_KEY: String = "theme"

timeFormatter

protected val timeFormatter: TimeFormatter

token

protected val token: String

TOKEN_KEY

val TOKEN_KEY: String = "token"

USERS_KEY

val USERS_KEY: String = "users"

Functions

convertToRelatedDTO

open fun convertToRelatedDTO(): AmetistaMember

Method to convert the object to related Transfer Data Object

getCompleteName

open fun getCompleteName(): String

getEmail

open fun getEmail(): String

getId

open fun getId(): String

getInstance

open fun getInstance(jUser: JSONObject): EquinoxUser

getLanguage

open fun getLanguage(): String

getName

open fun getName(): String

getPassword

open fun getPassword(): String

getProfilePic

open fun getProfilePic(): String

getSurname

open fun getSurname(): String

getTheme

open fun getTheme(): EquinoxUser.ApplicationTheme

getToken

open fun getToken(): String

getValidUserLanguage

open fun getValidUserLanguage(): String

isAdmin

open fun isAdmin(): Boolean

Method to get whether the user is a ADMIN

isViewer

open fun isViewer(): Boolean

Method to get whether the user is a VIEWER

toString

open fun toString(): String