Class User

First basic model for Ident

Hierarchy

CoreModel
- User

Properties

__ctx

__deleted

__store

_user

public

uuid

Methods

_onDelete

_onGet

_onSave

_onSaved

_onUpdate

_toJSON

addGroup

addRole

attach

canAct

canCreate

canDelete

canGet

canUpdate

delete

getAvailableActions

getGroups

getOwner

getRoles

getStore

hasRole

inGroup

lastPasswordRecoveryBefore

load

refresh

save

toJSON

update

validate

Properties

__ctx: Context

Object context

__deleted: boolean

If an object is deleted but not removed from DB for historic

__store: Store<CoreModel>

If object is attached to its store

_creationDate: Date

_lastUpdate: Date

_user: any

lastUpdate: Date

public: boolean

uuid: string

jsonExcludes: string[] = ["__store", "__ctx"]

Methods

_getSchema(): any

Inherited from User._getSchema

Return the object schema, if defined any modification done to the object by external source must comply to this schema

Returns any
- Defined in packages/core/src/models/coremodel.ts:208

_jsonFilter(key: any, value: any): any

Inherited from User._jsonFilter

Parameters
- key: any
- value: any
Returns any
- Defined in packages/core/src/models/coremodel.ts:236

_onDelete(): Promise<void>

Inherited from User._onDelete

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:290

_onDeleted(): Promise<void>

Inherited from User._onDeleted

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:291

_onGet(): Promise<void>

Inherited from User._onGet

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:292

_onSave(): Promise<void>

Inherited from User._onSave

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:293

_onSaved(): Promise<void>

Inherited from User._onSaved

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:294

_onUpdate(updates: any): Promise<void>

Inherited from User._onUpdate

Parameters
- updates: any
Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:295

_onUpdated(): Promise<void>

Inherited from User._onUpdated

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:296

_toJSON(secure: any): any

Inherited from User._toJSON

Parameters
- secure: any
Returns any
- Defined in packages/core/src/models/coremodel.ts:270

addGroup(group: string): void

Parameters
- group: string
Returns void
- Defined in packages/core/src/models/user.ts:43

addRole(role: string): void

Parameters
- role: string
Returns void
- Defined in packages/core/src/models/user.ts:24

attach(store: Store<CoreModel>): void

Inherited from User.attach

Attach an object to a store instance

Parameters
- store: Store<CoreModel>
Returns void
- Defined in packages/core/src/models/coremodel.ts:81

canAct(ctx: Context, action: string): Promise<this>

Inherited from OwnerPolicy.canAct

Parameters
- ctx: Context
- action: string
Returns Promise<this>
- Defined in packages/core/src/policies/ownerpolicy.ts:22

canCreate(ctx: Context): Promise<this>

Inherited from OwnerPolicy.canCreate

Return false if can't create

Parameters
- ctx: Context
Returns Promise<this>
- Defined in packages/core/src/policies/ownerpolicy.ts:10

canDelete(ctx: Context): Promise<this>

Inherited from OwnerPolicy.canDelete

Return false if can't delete

Parameters
- ctx: Context
Returns Promise<this>
- Defined in packages/core/src/policies/ownerpolicy.ts:61

canGet(ctx: Context): Promise<this>

Inherited from OwnerPolicy.canGet

Return false if can't get

Parameters
- ctx: Context
Returns Promise<this>
- Defined in packages/core/src/policies/ownerpolicy.ts:51

canUpdate(ctx: Context): Promise<this>

Inherited from OwnerPolicy.canUpdate

Return false if can't update

Parameters
- ctx: Context
Returns Promise<this>
- Defined in packages/core/src/policies/ownerpolicy.ts:37

delete(): Promise<void>

Inherited from User.delete

Delete this object

throws

Error if the object is not coming from a store

Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:165

generateUid(object?: any): string

Inherited from User.generateUid

Parameters
- Default value object: any = undefined
Returns string
- Defined in packages/core/src/models/coremodel.ts:232

getAvailableActions(): object

Inherited from User.getAvailableActions

Get actions available for the current instance of an object

Returns object
- Defined in packages/core/src/models/coremodel.ts:88

getContext(): Context

Inherited from User.getContext

Get object context

Global object does not belong to a request

Returns Context
- Defined in packages/core/src/models/coremodel.ts:125

getGroups(): string[]

Returns string[]
- Defined in packages/core/src/models/user.ts:16

getOwner(): any

Inherited from OwnerPolicy.getOwner

Returns any
- Defined in packages/core/src/policies/ownerpolicy.ts:18

getPassword(): string

Returns string
- Defined in packages/core/src/models/user.ts:69

getRoles(): string[]

Returns string[]
- Defined in packages/core/src/models/user.ts:20

getService<T>(service: any): T

Inherited from User.getService

Get a pre typed service

Type parameters
- T: Service
Parameters
- service: any
  
  to retrieve WARNING: Only object attached to a store can retrieve service
Returns T
- Defined in packages/core/src/models/coremodel.ts:263

getStore(): Store<CoreModel, StoreParameters>

Inherited from User.getStore

Return the object registered store

Returns Store<CoreModel, StoreParameters>
- Defined in packages/core/src/models/coremodel.ts:132

hasRole(role: string): boolean

Parameters
- role: string
Returns boolean
- Defined in packages/core/src/models/user.ts:31

inGroup(group: string): boolean

Parameters
- group: string
Returns boolean
- Defined in packages/core/src/models/user.ts:50

isAttached(): boolean

Inherited from User.isAttached

Return if an object is attached to its store

Returns boolean
- Defined in packages/core/src/models/coremodel.ts:74

lastPasswordRecoveryBefore(timestamp: number): boolean

Parameters
- timestamp: number
Returns boolean
- Defined in packages/core/src/models/user.ts:65

load(raw: any, secure?: boolean): void

Inherited from User.load

Load an object from RAW

Parameters
- raw: any
  
  data
- Default value secure: boolean = false
  
  if false will ignore any _ variable
Returns void
- Defined in packages/core/src/models/coremodel.ts:98

refresh(): Promise<CoreModel>

Inherited from User.refresh

Get the object again

throws

Error if the object is not coming from a store

Returns Promise<CoreModel>
- Defined in packages/core/src/models/coremodel.ts:141

removeGroup(group: string): void

Parameters
- group: string
Returns void
- Defined in packages/core/src/models/user.ts:57

removeRole(role: string): void

Parameters
- role: string
Returns void
- Defined in packages/core/src/models/user.ts:35

save(): Promise<this>

Inherited from User.save

Save this object

throws

Error if the object is not coming from a store

Returns Promise<this>
- Defined in packages/core/src/models/coremodel.ts:177

setContext(ctx: Context): void

Inherited from User.setContext

Context of the request

Parameters
- ctx: Context
Returns void
- Defined in packages/core/src/models/coremodel.ts:116

setPassword(password: string): void

Parameters
- password: string
Returns void
- Defined in packages/core/src/models/user.ts:73

toJSON(): any

Inherited from User.toJSON

Returns any
- Defined in packages/core/src/models/coremodel.ts:286

toStoredJSON(stringify?: boolean): any

Inherited from User.toStoredJSON

Parameters
- Default value stringify: boolean = false
Returns any
- Defined in packages/core/src/models/coremodel.ts:243

update(changes: any): Promise<void>

Inherited from User.update

Update this object

throws

Error if the object is not coming from a store

Parameters
- changes: any
Returns Promise<void>
- Defined in packages/core/src/models/coremodel.ts:193

validate(ctx: any, updates?: any): Promise<boolean>

Inherited from User.validate

Parameters
- ctx: any
- Default value updates: any = undefined
Returns Promise<boolean>
- Defined in packages/core/src/models/coremodel.ts:212

getActions(): object

Inherited from User.getActions

Get actions callable on an object

This will expose them by the Store with /storeUrl/{uuid}/{action}

Returns object
- Defined in packages/core/src/models/coremodel.ts:60

getUuidField(): string | string[]

Inherited from User.getUuidField

Get the UUID property

Returns string | string[]
- Defined in packages/core/src/models/coremodel.ts:67

Generated using TypeDoc