Class PanelUser

Implements

UserAttributes

Index

Constructors

Properties

2fa created_at email external_id? first_name id language last_name root_admin servers? updated_at username uuid

Methods

delete setEmail setFirstName setLanguage setLastName setPanelAdmin setPassword setUsername

Constructors

constructor

new PanelUser(applicationClient, userData): PanelUser
Parameters
- applicationClient: ApplicationClient
- userData: RawUser
Returns PanelUser
- Defined in src/ApplicationClient/PanelUser.ts:28

Properties

`Readonly`2fa

2fa: boolean

`Readonly`created_at

created_at: Date

email

email: string

`Optional`external_id

external_id?: null | string

first_name

first_name: string

`Readonly`id

id: number

language

language: string

last_name

last_name: string

root_admin

root_admin: boolean

`Optional`servers

servers?: PanelServer[]

updated_at

updated_at: Date

username

username: string

`Readonly`uuid

uuid: string

Methods

delete

delete(): Promise<void>
Delete this user from the panel

Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:49

setEmail

setEmail(email): Promise<void>
Update this user's email address on the panel
Parameters
- email: string
  The new email address
Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:80

setFirstName

setFirstName(firstName): Promise<void>
Update this user's first name on the panel
Parameters
- firstName: string
  The new first name
Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:104

setLanguage

setLanguage(language): Promise<void>
Update this user's language on the panel
Parameters
- language: string
  The new language
Returns Promise<void>
Default
```
language en
```
- Defined in src/ApplicationClient/PanelUser.ts:128

setLastName

setLastName(lastName): Promise<void>
Update this user's last name on the panel
Parameters
- lastName: string
  The new last name
Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:116

setPanelAdmin

setPanelAdmin(panelAdmin): Promise<void>
Update this user's admin status on the panel
Parameters
- panelAdmin: boolean
  Should the user be an admin
Returns Promise<void>
Default
```
panelAdmin false
```
- Defined in src/ApplicationClient/PanelUser.ts:151

setPassword

setPassword(password): Promise<void>
Update this user's password on the panel
Parameters
- password: string
  The new password
Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:139

setUsername

setUsername(username): Promise<void>
Update this user's username on the panel
Parameters
- username: string
  The new username
Returns Promise<void>
- Defined in src/ApplicationClient/PanelUser.ts:92