Class User

User

Hierarchy

User

Indexable

[key: string]: any

Constructors

constructor

new User(o): User
User constructor
Parameters
- o: UserCfg | User
Returns User
- Defined in saltcorn-data/models/user.ts:85

Properties

`Optional` _attributes

_attributes?: any

`Optional` api_token

api_token?: null | string

disabled

disabled: boolean

email

email: string

`Optional` id

id?: number

`Optional` language

language?: string

`Optional` last_mobile_login

last_mobile_login?: null | Date

password

password: string

`Optional` reset_password_expiry

reset_password_expiry?: null | Date

`Optional` reset_password_token

reset_password_token?: null | string

role_id

role_id: number

`Optional` verification_token

verification_token?: string

`Optional` verified_on

verified_on?: Date

Accessors

session_object

get session_object(): any
Create session object for user

Returns any
- Defined in saltcorn-data/models/user.ts:238

`Static` table

get table(): Table
Returns Table
- Defined in saltcorn-data/models/user.ts:260

Methods

changePasswordTo

changePasswordTo(newpw, expireToken?): Promise<void>
Change password
Parameters
- newpw: string
  
  new password string
- Optional expireToken: boolean
  
  if true than force reset password token
Returns Promise<void>
no result
- Defined in saltcorn-data/models/user.ts:132

checkPassword

checkPassword(pw): boolean
Check password
Parameters
- pw: string
  
  password string
Returns boolean
- Defined in saltcorn-data/models/user.ts:122

delete

delete(): Promise<void>
Delete user based on session object

Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:394

destroy_sessions

destroy_sessions(): Promise<void>
Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:593

getNewAPIToken

getNewAPIToken(): Promise<string>
Add new API token to user

Returns Promise<string>
- Defined in saltcorn-data/models/user.ts:442

getNewResetToken

getNewResetToken(): Promise<string>
Get new reset token

Returns Promise<string>
- Defined in saltcorn-data/models/user.ts:429

relogin

relogin(req): Promise<void>
Parameters
- req: any
Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:609

removeAPIToken

removeAPIToken(): Promise<null>
Remove API token for user

Returns Promise<null>
- Defined in saltcorn-data/models/user.ts:453

send_verification_email

send_verification_email(req?, opts?): Promise<any>
Parameters
- Optional req: any
- Optional opts: {
  new_verification_token?: string;
  }
  - Optional new_verification_token?: string
Returns Promise<any>
- Defined in saltcorn-data/models/user.ts:279

set_language

set_language(language): Promise<void>
Set language for User in database
Parameters
- language: string
Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:411

set_to_verified

set_to_verified(): Promise<true>
Returns Promise<true>
- Defined in saltcorn-data/models/user.ts:503

update

update(row): Promise<void>
Update User
Parameters
- row: Row
Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:420

updateLastMobileLogin

updateLastMobileLogin(date): Promise<void>
update 'last_mobile_login' columnwill
Parameters
- date: null | Date
  
  new login_date or null for logout (invalidates all jwts)
Returns Promise<void>
- Defined in saltcorn-data/models/user.ts:622

`Static` authenticate

authenticate(uo): Promise<false | User>
Authenticate User
Parameters
- uo: any
  
  user object
Returns Promise<false | User>
- Defined in saltcorn-data/models/user.ts:269

`Static` count

count(where?): Promise<number>
Count users in database
Parameters
- Optional where: Where
Returns Promise<number>
- Defined in saltcorn-data/models/user.ts:567

`Static` create

create(uo): Promise<User | ErrorMessage>
Create user
Parameters
- uo: GenObj
  
  user object
Returns Promise<User | ErrorMessage>
- Defined in saltcorn-data/models/user.ts:180

`Static` find

find(where, selectopts?): Promise<User[]>
Find users list
Parameters
- where: Where
  
  where object
- Optional selectopts: SelectOptions
  
  select options
Returns Promise<User[]>
- Defined in saltcorn-data/models/user.ts:362

`Static` findForSession

findForSession(where): Promise<false | User>
Find users list
Parameters
- where: Where
  
  where object
Returns Promise<false | User>
- Defined in saltcorn-data/models/user.ts:292

`Static` findOne

findOne(where): Promise<undefined | User>
Find one user
Parameters
- where: Where
  
  where object
Returns Promise<undefined | User>
- Defined in saltcorn-data/models/user.ts:375

`Static` findOrCreateByAttribute

findOrCreateByAttribute(k, v, uo?): Promise<false | User | ErrorMessage>
Find or Create User
Parameters
- k: string
- v: any
- Optional uo: any = {}
Returns Promise<false | User | ErrorMessage>
- Defined in saltcorn-data/models/user.ts:147

`Static` generate_password

generate_password(): string
Generate password

Returns string
- Defined in saltcorn-data/models/user.ts:583

`Static` get_roles

get_roles(): Promise<undefined | Row[]>
Get available roles

Returns Promise<undefined | Row[]>
- Defined in saltcorn-data/models/user.ts:575

`Static` hashPassword

hashPassword(pw): Promise<string>
Get bcrypt hash for Password
Parameters
- pw: string
  
  password string
Returns Promise<string>
- Defined in saltcorn-data/models/user.ts:113

`Static` matches_existing_user

matches_existing_user(uo): Promise<boolean>
Parameters
- uo: any
Returns Promise<boolean>
- Defined in saltcorn-data/models/user.ts:221

`Static` nonEmpty

nonEmpty(): Promise<boolean>
Check that user table is not empty in database

Returns Promise<boolean>
true if there are users in db

Deprecated
use method count()
- Defined in saltcorn-data/models/user.ts:385

`Static` resetPasswordWithToken

resetPasswordWithToken(__namedParameters): Promise<ErrorMessage | SuccessMessage>
Reset password using token
Parameters
- __namedParameters: {
      email: string;
      password: string;
      reset_password_token: string;
  }
  - email: string
  - password: string
  - reset_password_token: string
Returns Promise<ErrorMessage | SuccessMessage>
- Defined in saltcorn-data/models/user.ts:524

`Static` unacceptable_password_reason

unacceptable_password_reason(pw): undefined | string
Validate password
Parameters
- pw: string
Returns undefined | string
- Defined in saltcorn-data/models/user.ts:465

`Static` valid_email

valid_email(email): boolean
Validate email
Parameters
- email: string
Returns boolean
- Defined in saltcorn-data/models/user.ts:476

`Static` verifyWithToken

verifyWithToken(__namedParameters): Promise<true | ErrorMessage>
Verification with token
Parameters
- __namedParameters: {
  email: string;
  verification_token: string;
  }
  - email: string
  - verification_token: string
Returns Promise<true | ErrorMessage>
true if verification passed, error string if not
- Defined in saltcorn-data/models/user.ts:486

Generated using TypeDoc