User

Defined in: js-api/src/entities/user.ts:22

Represents a user of the Datagrok platform.

Extends

• Entity

Constructors

Constructor

new User(dart): User

Defined in: js-api/src/entities/user.ts:24

Parameters

Parameter	Type
dart	any

Returns

User

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
dart	public	any	Entity.dart	js-api/src/entities/entity.ts:19

Accessors

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:57

Who created entity *

Returns

any

Inherited from

Entity.author

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

email

Get Signature

get email(): string | null

Defined in: js-api/src/entities/user.ts:49

Email

Returns

string | null

Set Signature

set email(email): void

Defined in: js-api/src/entities/user.ts:50

Parameters

Parameter	Type
email	string | null

Returns

void

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

firstName

Get Signature

get firstName(): string

Defined in: js-api/src/entities/user.ts:38

First name

Returns

string

Set Signature

set firstName(name): void

Defined in: js-api/src/entities/user.ts:39

Parameters

Parameter	Type
name	string

Returns

void

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

group

Get Signature

get group(): Group

Defined in: js-api/src/entities/user.ts:68

Security Group

Returns

Group

---

home

Get Signature

get home(): any

Defined in: js-api/src/entities/user.ts:59

User home folder connection

Returns

any

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

joined

Get Signature

get joined(): Dayjs

Defined in: js-api/src/entities/user.ts:71

Date when user joined

Returns

Dayjs

---

lastName

Get Signature

get lastName(): string

Defined in: js-api/src/entities/user.ts:42

Last name

Returns

string

Set Signature

set lastName(name): void

Defined in: js-api/src/entities/user.ts:43

Parameters

Parameter	Type
name	string

Returns

void

---

login

Get Signature

get login(): string

Defined in: js-api/src/entities/user.ts:62

Login

Returns

string

Set Signature

set login(login): void

Defined in: js-api/src/entities/user.ts:63

Parameters

Parameter	Type
login	string

Returns

void

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:38

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:39

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

picture

Get Signature

get picture(): string | object

Defined in: js-api/src/entities/user.ts:53

Picture URL

Returns

string | object

---

project

Get Signature

get project(): any

Defined in: js-api/src/entities/user.ts:56

User home project

Returns

any

---

status

Get Signature

get status(): USER_STATUS

Defined in: js-api/src/entities/user.ts:45

Returns

USER_STATUS

Set Signature

set status(name): void

Defined in: js-api/src/entities/user.ts:46

Parameters

Parameter	Type
name	USER_STATUS

Returns

void

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

---

admin

Get Signature

get static admin(): User

Defined in: js-api/src/entities/user.ts:83

Returns

User

---

defaultUsersIds

Get Signature

get static defaultUsersIds(): object

Defined in: js-api/src/entities/user.ts:73

Returns

object

Name	Type	Default value	Defined in
Admin	"878c42b0-9a50-11e6-c537-6bf8e9ab02ee"	"878c42b0-9a50-11e6-c537-6bf8e9ab02ee"	js-api/src/entities/user.ts:76
System	"3e32c5fa-ac9c-4d39-8b4b-4db3e576b3c3"	"3e32c5fa-ac9c-4d39-8b4b-4db3e576b3c3"	js-api/src/entities/user.ts:77
Test	"ca1e672e-e3be-40e0-b79b-d2c68e68d380"	"ca1e672e-e3be-40e0-b79b-d2c68e68d380"	js-api/src/entities/user.ts:75

---

system

Get Signature

get static system(): User

Defined in: js-api/src/entities/user.ts:85

Returns

User

---

test

Get Signature

get static test(): User

Defined in: js-api/src/entities/user.ts:81

Returns

User

Methods

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: js-api/src/entities/entity.ts:67

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toMarkup()

toMarkup(): string

Defined in: js-api/src/entities/user.ts:65

Returns

string

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

---

create()

static create(): User

Defined in: js-api/src/entities/user.ts:30

Creates a new user. Note that it's just a client object, it won't be saved in the database.

Returns

User

---

current()

static current(): User

Defined in: js-api/src/entities/user.ts:35

Returns current user.

Returns

User

---

fromId()

static fromId(id): User

Defined in: js-api/src/entities/user.ts:32

Parameters

Parameter	Type
id	string

Returns

User