Entity
Defined in: js-api/src/entities/entity.ts:17
Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path
Extended by
UserUserSessionGroupFuncScriptEnvironmentDataConnectionCredentialsTableInfoColumnInfoFileInfoLogEventTypeLogEventLogEventParameterLogEventParameterValueProjectViewLayoutViewInfoUserReportUserReportsRuleDomainSchemaDomainTableDomainSavedFilterModelNotebookPackageDockerContainerDockerImageFuncCall
Constructors
Constructor
new Entity(
dart):Entity
Defined in: js-api/src/entities/entity.ts:22
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Entity
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
dart | public | any | 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
createdOn
Get Signature
get createdOn():
Dayjs
Defined in: js-api/src/entities/entity.ts:48
Time when entity was created *
Returns
Dayjs
entityType
Get Signature
get entityType():
string
Defined in: js-api/src/entities/entity.ts:64
Entity type name *
Returns
string
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
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
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
nqName
Get Signature
get nqName():
string
Defined in: js-api/src/entities/entity.ts:42
Entity full-qualified name
Returns
string
path
Get Signature
get path():
string
Defined in: js-api/src/entities/entity.ts:45
Entity path
Returns
string
updatedOn
Get Signature
get updatedOn():
Dayjs|null
Defined in: js-api/src/entities/entity.ts:51
Time when entity was updated *
Returns
Dayjs | null
Methods
getProperties()
getProperties():
Promise<{[index:string]:any; }>
Defined in: js-api/src/entities/entity.ts:67
Gets entity properties
Returns
Promise<{[index: string]: any; }>
hasTag()
hasTag(
tag):boolean
Defined in: js-api/src/entities/entity.ts:79
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean
newId()
newId():
void
Defined in: js-api/src/entities/entity.ts:31
Generates new id for this entity.
Returns
void
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>
tag()
tag(
tag):boolean
Defined in: js-api/src/entities/entity.ts:82
Adds a specified tag
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean
toString()
toString():
string
Defined in: js-api/src/entities/entity.ts:77
Returns a string representing the object
Returns
string
unTag()
unTag(
tag):boolean
Defined in: js-api/src/entities/entity.ts:85
Removes a specified tag
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean