Skip to main content

User

Represents a user of the Datagrok platform.

Extends

Constructors

new User()

new User(dart): User

Parameters

ParameterType
dartany

Returns

User

Overrides

Entity . constructor

Constructs

User

Source

src/entities.ts:149

Properties

PropertyModifierTypeInherited from
dartpublicanyEntity.dart

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:119


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:110


email

get email(): null | string

Email

set email(email): void

Parameters

ParameterType
emailnull | string

Returns

null | string

Source

src/entities.ts:174


firstName

get firstName(): string

First name

set firstName(name): void

Parameters

ParameterType
namestring

Returns

string

Source

src/entities.ts:163


friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:96


group

get group(): Group

Security Group

Returns

Group

Source

src/entities.ts:193


home

get home(): DataConnection

User home folder connection

Returns

DataConnection

Source

src/entities.ts:184


id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:88


lastName

get lastName(): string

Last name

set lastName(name): void

Parameters

ParameterType
namestring

Returns

string

Source

src/entities.ts:167


login

get login(): string

Login

set login(login): void

Parameters

ParameterType
loginstring

Returns

string

Source

src/entities.ts:187


name

get name(): string

Entity short name

set name(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:100


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:104


path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:107


picture

get picture(): string | object

Picture URL

Returns

string | object

Source

src/entities.ts:178


project

get project(): Project

User home project

Returns

Project

Source

src/entities.ts:181


status

get status(): USER_STATUS

set status(name): void

Parameters

ParameterType
nameUSER_STATUS

Returns

USER_STATUS

Source

src/entities.ts:170


updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:113


defaultUsersIds

get static defaultUsersIds(): object

Returns

object

MemberTypeValue
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:195

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:122


hasTag()

hasTag(tag): boolean

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:134


newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:92


setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

ParameterType
propsobject

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:127


tag()

tag(tag): boolean

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:137


toMarkup()

toMarkup(): string

Returns

string

Source

src/entities.ts:190


toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:132


unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:140


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:155


current()

static current(): User

Returns current user.

Returns

User

Source

src/entities.ts:160


fromId()

static fromId(id): User

Parameters

ParameterType
idstring

Returns

User

Source

src/entities.ts:157