Class: User

Class: User#

Describes a single authorized user in the AcceleratXR ecosystem.

REQUIRES: Account Services

author Jean-Philippe Steinmetz info@acceleratxr.com

Hierarchy#

Index#

Constructors#

Properties#

Accessors#

Object literals#

Constructors#

constructor#

+ new User(other?: any): User

Overrides EntityBase.constructor

Defined in src/models/User.ts:85

Parameters:#

Name

Type

other?

any

Returns: User

Properties#

birthdate#

• birthdate: string | null = null

Defined in src/models/User.ts:47

The user’s date of birth expressed as a string of the form DD/MM/YYYY.

dateCreated#

• dateCreated: Date = new Date()

Inherited from EntityBase.dateCreated

Defined in src/EntityBase.ts:18

The date and time that the object was created.

dateModified#

• dateModified: Date = new Date()

Inherited from EntityBase.dateModified

Defined in src/EntityBase.ts:23

The date and time that the object was last modified.

email#

• email: string | null = null

Defined in src/models/User.ts:32

The unique e-mail address of the user.

externalIds#

• externalIds: Array<string> = new Array()

Defined in src/models/User.ts:72

The list of unique identifiers for each third-party platform the user is linked to.

familyName#

• familyName: string | null = null

Defined in src/models/User.ts:42

The user’s family name or surname.

givenName#

• givenName: string | null = null

Defined in src/models/User.ts:37

The user’s given (first) name.

lastLogin#

• lastLogin: Date | null = null

Defined in src/models/User.ts:85

The user’s last name or surname.

locale#

• locale: string | null = null

Defined in src/models/User.ts:52

The user’s detected or preferred geographic locale. E.g. en-US

name#

• name: string = “”

Defined in src/models/User.ts:27

The unique name of the user.

orgs#

• orgs: Array<string> = new Array()

Defined in src/models/User.ts:57

The list of organizations (by uid) that the user is apart of and will assume privileges for.

phone#

• phone: string | null = null

Defined in src/models/User.ts:62

The user’s telephone number.

roles#

• roles: Array<string> = new Array()

Defined in src/models/User.ts:67

The list of roles (by name) that the user is apart of and will assume privileges for.

uid#

• uid: string = uuid.v4()

Inherited from EntityBase.uid

Defined in src/EntityBase.ts:13

The universally unique identifier of the object.

version#

• version: number = 0

Inherited from EntityBase.version

Defined in src/EntityBase.ts:28

The optimistic locking version of the object.

Accessors#

ClassName#

• Staticget ClassName(): string

Defined in src/models/User.ts:22

Returns: string

Object literals#

verified#

▪ verified: object

Defined in src/models/User.ts:77

Indicates if the account verification status of the user.

Properties:#

Name

Type

Value

email

false

false

phone

false

false