User

Represents a user of the Datagrok platform.

Extends

• Entity

Constructors

new User()

new User(dart): User

Parameters

Parameter	Type
dart	any

Returns

User

Overrides

Entity . constructor

Constructs

User

Source

src/entities.ts:138

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:108

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:99

---

email

get email(): null | string

Email

set email(email): void

Parameters

Parameter	Type
email	null | string

Returns

null | string

Source

src/entities.ts:163

---

firstName

get firstName(): string

First name

set firstName(name): void

Parameters

Parameter	Type
name	string

Returns

string

Source

src/entities.ts:152

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:85

---

group

get group(): Group

Security Group

Returns

Group

Source

src/entities.ts:182

---

home

get home(): DataConnection

User home folder connection

Returns

DataConnection

Source

src/entities.ts:173

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:77

---

lastName

get lastName(): string

Last name

set lastName(name): void

Parameters

Parameter	Type
name	string

Returns

string

Source

src/entities.ts:156

---

login

get login(): string

Login

set login(login): void

Parameters

Parameter	Type
login	string

Returns

string

Source

src/entities.ts:176

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:89

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:93

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:96

---

picture

get picture(): string | object

Picture URL

Returns

string | object

Source

src/entities.ts:167

---

project

get project(): Project

User home project

Returns

Project

Source

src/entities.ts:170

---

status

get status(): USER_STATUS

set status(name): void

Parameters

Parameter	Type
name	USER_STATUS

Returns

USER_STATUS

Source

src/entities.ts:159

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:102

---

defaultUsersIds

get static defaultUsersIds(): object

Returns

object

Member	Type	Value
Admin	"878c42b0-9a50-11e6-c537-6bf8e9ab02ee"	"878c42b0-9a50-11e6-c537-6bf8e9ab02ee"
System	"3e32c5fa-ac9c-4d39-8b4b-4db3e576b3c3"	"3e32c5fa-ac9c-4d39-8b4b-4db3e576b3c3"
Test	"ca1e672e-e3be-40e0-b79b-d2c68e68d380"	"ca1e672e-e3be-40e0-b79b-d2c68e68d380"

Source

src/entities.ts:184

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:111

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:123

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:81

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:116

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:126

---

toMarkup()

toMarkup(): string

Returns

string

Source

src/entities.ts:179

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:121

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:129

---

create()

static create(): User

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

Returns

User

Source

src/entities.ts:144

---

current()

static current(): User

Returns current user.

Returns

User

Source

src/entities.ts:149

---

fromId()

static fromId(id): User

Parameters

Parameter	Type
id	string

Returns

User

Source

src/entities.ts:146