Options
All
  • Public
  • Public/Protected
  • All
Menu

Representation of the user model in Engine

Hierarchy

Index

Constructors

constructor

Properties

Protected _changes

_changes: HashMap

Map of unsaved property changes

Protected Optional _init_sub

_init_sub: Subscription

Subscription for initialisation events

Protected _server_names

_server_names: HashMap

Map of local property names to server ones

Protected _service

Protected _version

_version: number

Version of the data

authority_id

authority_id: string

ID of the authority associated with the user

changeEvents

changeEvents: Subject<EngineDataClassEvent> = new Subject<EngineDataClassEvent>()

Subject for change events to the class object

country

country: string

Country that the user resides in

created_at

created_at: number

Unix epoch in seconds of the creation time of the object

email

email: string

Email address of the user

email_digest

email_digest: string

Hash of the email address of the user

first_name

first_name: string

First name of the user

id

id: string

Unique Identifier of the object

image

image: string

Avatar image for the user

last_name

last_name: string

Last name of the user

login_name

login_name: string

Username credential of the user

metadata

metadata: string

Additional metadata associated with the user

name

name: string

Human readable name of the object

phone

phone: string

Phone number of the user

staff_id

staff_id: string

Organisation ID of the user

support

support: boolean

Whether user is a support role

sys_admin

sys_admin: boolean

Whether user is a system admin role

Accessors

changes

Methods

Protected change

  • change<U>(prop_name: string, value: U): void

clearPendingChanges

  • clearPendingChanges(): void

delete

  • delete(): Promise<void>

emit

save

storePendingChange

  • storePendingChange(key: UserMutableFields, value: EngineUser[UserMutableFields]): this

toJSON

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc