User
Represents a user of the Datagrok platform.
Extends
Constructors
new User()
new User(
dart
):User
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
Overrides
Constructs
User
Source
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
dart | public | any | Entity .dart |
Accessors
author
get
author():User
Who created entity *
Returns
Source
createdOn
get
createdOn():Dayjs
Time when entity was created *
Returns
Dayjs
Source
email
get
email():null
|string
set
email(void
Parameters
Parameter | Type |
---|---|
email | null | string |
Returns
null
| string
Source
firstName
get
firstName():string
First name
set
firstName(name
):void
Parameters
Parameter | Type |
---|---|
name | string |
Returns
string
Source
friendlyName
get
friendlyName():string
Entity friendly name
set
friendlyName(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
group
get
group():Group
Security Group
Returns
Source
home
get
home():DataConnection
User home folder connection
Returns
Source
id
get
id():string
Entity ID (GUID)
set
id(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
lastName
get
lastName():string
Last name
set
lastName(name
):void
Parameters
Parameter | Type |
---|---|
name | string |
Returns
string
Source
login
get
login():string
Login
set
login(login
):void
Parameters
Parameter | Type |
---|---|
login | string |
Returns
string
Source
name
get
name():string
Entity short name
set
name(x
):void
Parameters
Parameter | Type |
---|---|
x | string |
Returns
string
Source
nqName
get
nqName():string
Entity full-qualified name
Returns
string
Source
path
get
path():string
Entity path
Returns
string
Source
picture
get
picture():string
|object
Picture URL
Returns
string
| object
Source
project
get
project():Project
User home project
Returns
Source
status
get
status():USER_STATUS
set
status(name
):void
Parameters
Parameter | Type |
---|---|
name | USER_STATUS |
Returns
Source
updatedOn
get
updatedOn():null
|Dayjs
Time when entity was updated *
Returns
null
| Dayjs
Source
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
Methods
getProperties()
getProperties():
Promise
<object
>
Gets entity properties
Returns
Promise
<object
>
Inherited from
Source
hasTag()
hasTag(
tag
):boolean
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
newId()
newId():
void
Generates new id for this entity.
Returns
void
Inherited from
Source
setProperties()
setProperties(
props
):Promise
<any
>
Sets entity properties
Parameters
Parameter | Type |
---|---|
props | object |
Returns
Promise
<any
>
Inherited from
Source
tag()
tag(
tag
):boolean
Adds a specified tag
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
toMarkup()
toMarkup():
string
Returns
string
Source
toString()
toString():
string
Returns a string representing the object
Returns
string
Inherited from
Source
unTag()
unTag(
tag
):boolean
Removes a specified tag
Parameters
Parameter | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Source
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
Source
current()
static
current():User
Returns current user.
Returns
Source
fromId()
static
fromId(id
):User
Parameters
Parameter | Type |
---|---|
id | string |