Class: User

dg.User

Represents a user of the Datagrok platform.

Hierarchy

• Entity

  ↳ User

Constructors

constructor

• new User(dart)

Constructs

User

Parameters

Name	Type
dart	any

Overrides

Entity.constructor

Defined in

src/entities.ts:134

Properties

dart

• dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

Accessors

author

• get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

email

• get email(): null | string

Email

Returns

null | string

Defined in

src/entities.ts:159

• set email(email): void

Parameters

Name	Type
email	null | string

Returns

void

Defined in

src/entities.ts:160

---

firstName

• get firstName(): string

First name

Returns

string

Defined in

src/entities.ts:148

• set firstName(name): void

Parameters

Name	Type
name	string

Returns

void

Defined in

src/entities.ts:149

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

group

• get group(): Group

Security Group

Returns

Group

Defined in

src/entities.ts:178

---

home

• get home(): DataConnection

User home folder connection

Returns

DataConnection

Defined in

src/entities.ts:169

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

lastName

• get lastName(): string

Last name

Returns

string

Defined in

src/entities.ts:152

• set lastName(name): void

Parameters

Name	Type
name	string

Returns

void

Defined in

src/entities.ts:153

---

login

• get login(): string

Login

Returns

string

Defined in

src/entities.ts:172

• set login(login): void

Parameters

Name	Type
login	string

Returns

void

Defined in

src/entities.ts:173

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

path

• get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95

---

picture

• get picture(): string | object

Picture URL

Returns

string | object

Defined in

src/entities.ts:163

---

project

• get project(): Project

User home project

Returns

Project

Defined in

src/entities.ts:166

---

status

• get status(): USER_STATUS

Returns

USER_STATUS

Defined in

src/entities.ts:155

• set status(name): void

Parameters

Name	Type
name	USER_STATUS

Returns

void

Defined in

src/entities.ts:156

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

---

defaultUsersIds

• Static get defaultUsersIds(): Object

Returns

Object

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

Defined in

src/entities.ts:180

Methods

getProperties

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

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

toMarkup

▸ toMarkup(): string

Returns

string

Defined in

src/entities.ts:175

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125

---

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

Defined in

src/entities.ts:140

---

current

▸ Static current(): User

Returns current user.

Returns

User

Defined in

src/entities.ts:145

---

fromId

▸ Static fromId(id): User

Parameters

Name	Type
id	string

Returns

User

Defined in

src/entities.ts:142