Class: IQUser

user.IQUser

User class for managing individual users

Table of contents

Constructors

• constructor

Accessors

• access
• email
• handle
• id
• location
• loggedIn
• realName
• stats

Methods

• changePassword
• delete
• exists
• getCustom
• getRawData
• hasAccess
• incrementPosts
• login
• logout
• recordDownload
• recordUpload
• register
• resetPassword
• save
• setCustom
• update

Constructors

constructor

• new IQUser(options)

Parameters

Name	Type
options	IUserOptions

Defined in

core/src/user.ts:281

Accessors

access

• get access(): UserAccessLevel

Get user access level

Returns

UserAccessLevel

Defined in

core/src/user.ts:309

• set access(level): void

Set user access level

Parameters

Name	Type
level	UserAccessLevel

Returns

void

Defined in

core/src/user.ts:316

---

email

• get email(): string

Get user email

Returns

string

Defined in

core/src/user.ts:325

---

handle

• get handle(): string

Get user handle

Returns

string

Defined in

core/src/user.ts:295

---

id

• get id(): number

Get user ID

Returns

number

Defined in

core/src/user.ts:302

---

location

• get location(): string

Get user location

Returns

string

Defined in

core/src/user.ts:339

---

loggedIn

• get loggedIn(): boolean

Check if user is currently logged in

Returns

boolean

Defined in

core/src/user.ts:369

---

realName

• get realName(): string

Get user real name

Returns

string

Defined in

core/src/user.ts:332

---

stats

• get stats(): IUserStats

Get user statistics

Returns

IUserStats

Defined in

core/src/user.ts:346

Methods

changePassword

▸ changePassword(oldPassword, newPassword): boolean

Change password

Parameters

Name	Type
oldPassword	string
newPassword	string

Returns

boolean

Defined in

core/src/user.ts:561

---

delete

▸ delete(): boolean

Delete user

Returns

boolean

Defined in

core/src/user.ts:469

---

exists

▸ exists(): boolean

Check if user exists in database

Returns

boolean

Defined in

core/src/user.ts:362

---

getCustom

▸ getCustom(key): any

Get custom user property

Parameters

Name	Type
key	string

Returns

any

Defined in

core/src/user.ts:482

---

getRawData

▸ getRawData(): null | IUserData

Get raw user data

Returns

null | IUserData

Defined in

core/src/user.ts:541

---

hasAccess

▸ hasAccess(requiredLevel): boolean

Check if user has required access level

Parameters

Name	Type
requiredLevel	UserAccessLevel

Returns

boolean

Defined in

core/src/user.ts:502

---

incrementPosts

▸ incrementPosts(): void

Increment post count

Returns

void

Defined in

core/src/user.ts:509

---

login

▸ login(password?): boolean

Attempt to login

Parameters

Name	Type
password?	string

Returns

boolean

Defined in

core/src/user.ts:391

---

logout

▸ logout(): void

Logout user

Returns

void

Defined in

core/src/user.ts:420

---

recordDownload

▸ recordDownload(bytes): void

Record download

Parameters

Name	Type
bytes	number

Returns

void

Defined in

core/src/user.ts:530

---

recordUpload

▸ recordUpload(bytes): void

Record upload

Parameters

Name	Type
bytes	number

Returns

void

Defined in

core/src/user.ts:519

---

register

▸ register(password?): boolean

Register a new user

Parameters

Name	Type
password?	string

Returns

boolean

Defined in

core/src/user.ts:433

---

resetPassword

▸ resetPassword(newPassword): boolean

Reset password (admin function)

Parameters

Name	Type
newPassword	string

Returns

boolean

Defined in

core/src/user.ts:572

---

save

▸ save(): boolean

Save user data

Returns

boolean

Defined in

core/src/user.ts:461

---

setCustom

▸ setCustom(key, value): void

Set custom user property

Parameters

Name	Type
key	string
value	any

Returns

void

Defined in

core/src/user.ts:489

---

update

▸ update(updates): boolean

Update user data

Parameters

Name	Type
updates	Partial<IUserData>

Returns

boolean

Defined in

core/src/user.ts:548