Skip to main content

LogEvent

Defined in: src/entities/logging.ts:32

Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path

Extends

Constructors

Constructor

new LogEvent(dart): LogEvent

Defined in: src/entities/logging.ts:33

Parameters

ParameterType
dartany

Returns

LogEvent

Overrides

Entity.constructor

Properties

PropertyModifierTypeInherited fromDefined in
dartpublicanyEntity.dartsrc/entities/entity.ts:19

Accessors

author

Get Signature

get author(): any

Defined in: src/entities/entity.ts:59

Who created entity *

Returns

any

Inherited from

Entity.author


createdOn

Get Signature

get createdOn(): Dayjs

Defined in: src/entities/entity.ts:50

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn


description

Get Signature

get description(): string

Defined in: src/entities/logging.ts:38

Description of the event

Returns

string


entityType

Get Signature

get entityType(): string

Defined in: src/entities/entity.ts:66

Entity type name *

Returns

string

Inherited from

Entity.entityType


eventTime

Get Signature

get eventTime(): Dayjs

Defined in: src/entities/logging.ts:54

Returns

Dayjs


eventType

Get Signature

get eventType(): LogEventType

Defined in: src/entities/logging.ts:52

Type of the event

Returns

LogEventType


friendlyName

Get Signature

get friendlyName(): string

Defined in: src/entities/entity.ts:36

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: src/entities/entity.ts:37

Parameters
ParameterType
xstring
Returns

void

Inherited from

Entity.friendlyName


id

Get Signature

get id(): string

Defined in: src/entities/entity.ts:28

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: src/entities/entity.ts:29

Parameters
ParameterType
xstring
Returns

void

Inherited from

Entity.id


name

Get Signature

get name(): string

Defined in: src/entities/logging.ts:41

Friendly name of the event

Returns

string

Overrides

Entity.name


nqName

Get Signature

get nqName(): string

Defined in: src/entities/entity.ts:44

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName


parameters

Get Signature

get parameters(): LogEventParameterValue[]

Defined in: src/entities/logging.ts:48

Parameters of the event

Returns

LogEventParameterValue[]


path

Get Signature

get path(): string

Defined in: src/entities/entity.ts:47

Entity path

Returns

string

Inherited from

Entity.path


session

Get Signature

get session(): string | UserSession

Defined in: src/entities/logging.ts:44

Session id of the event

Returns

string | UserSession


updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: src/entities/entity.ts:53

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

Methods

getProperties()

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

Defined in: src/entities/entity.ts:69

Gets entity properties

Returns

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

Inherited from

Entity.getProperties


hasTag()

hasTag(tag): boolean

Defined in: src/entities/entity.ts:81

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.hasTag


newId()

newId(): void

Defined in: src/entities/entity.ts:32

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId


setProperties()

setProperties(props): Promise<any>

Defined in: src/entities/entity.ts:74

Sets entity properties

Parameters

ParameterType
props{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties


tag()

tag(tag): boolean

Defined in: src/entities/entity.ts:84

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.tag


toString()

toString(): string

Defined in: src/entities/entity.ts:79

Returns a string representing the object

Returns

string

Inherited from

Entity.toString


unTag()

unTag(tag): boolean

Defined in: src/entities/entity.ts:87

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.unTag