Skip to main content

Class: Entity

dg.Entity

Hierarchy​

Constructors​

constructor​

• new Entity(dart)

Constructs

Entity

Parameters​

NameType
dartany

Defined in​

src/entities.ts:70

Properties​

dart​

• dart: any

Defined in​

src/entities.ts:67

Accessors​

author​

• get author(): User

Who created entity *

Returns​

User

Defined in​

src/entities.ts:104

createdOn​

• get createdOn(): Dayjs

Time when entity was created *

Returns​

Dayjs

Defined in​

src/entities.ts:98

friendlyName​

• get friendlyName(): string

Entity friendly name

Returns​

string

Defined in​

src/entities.ts:84

• set friendlyName(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/entities.ts:85

id​

• get id(): string

Entity ID (GUID)

Returns​

string

Defined in​

src/entities.ts:76

• set id(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/entities.ts:77

name​

• get name(): string

Entity short name

Returns​

string

Defined in​

src/entities.ts:88

• set name(x): void

Parameters​

NameType
xstring

Returns​

void

Defined in​

src/entities.ts:89

nqName​

• get nqName(): string

Entity full-qualified name

Returns​

string

Defined in​

src/entities.ts:92

path​

• get path(): string

Entity path

Returns​

string

Defined in​

src/entities.ts:95

updatedOn​

• get updatedOn(): Dayjs

Time when entity was updated *

Returns​

Dayjs

Defined in​

src/entities.ts:101

Methods​

getProperties​

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

Gets entity properties

Returns​

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

Defined in​

src/entities.ts:107

hasTag​

▸ hasTag(tag): boolean

Parameters​

NameType
tagstring

Returns​

boolean

Defined in​

src/entities.ts:119

newId​

▸ newId(): void

Generates new id for this entity.

Returns​

void

Defined in​

src/entities.ts:80

setProperties​

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters​

NameType
propsObject

Returns​

Promise<any>

Defined in​

src/entities.ts:112

tag​

▸ tag(tag): boolean

Adds a specified tag

Parameters​

NameType
tagstring

Returns​

boolean

Defined in​

src/entities.ts:122

toString​

▸ toString(): string

Returns a string representing the object

Returns​

string

Defined in​

src/entities.ts:117

unTag​

▸ unTag(tag): boolean

Removes a specified tag

Parameters​

NameType
tagstring

Returns​

boolean

Defined in​

src/entities.ts:125