Skip to main content

UserReport

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

Extends

Constructors

new UserReport()

new UserReport(dart): UserReport

Parameters

ParameterType
dartany

Returns

UserReport

Overrides

Entity . constructor

Source

src/entities.ts:1771

Properties

PropertyModifierTypeInherited from
dartpublicanyEntity.dart

Accessors

assignee

get assignee(): User

Returns

User

Source

src/entities.ts:1783


author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:1795


description

get description(): string

Returns

string

Source

src/entities.ts:1791


friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:101


id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:93


isResolved

get isResolved(): boolean

Returns

boolean

Source

src/entities.ts:1775


jiraTicket

get jiraTicket(): string

Returns

string

Source

src/entities.ts:1779


name

get name(): string

Entity short name

set name(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:105


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:109


path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:112


reporter

get reporter(): User

Returns

User

Source

src/entities.ts:1787


updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:118

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:127


hasTag()

hasTag(tag): boolean

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:139


newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:97


setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

ParameterType
propsobject

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:132


tag()

tag(tag): boolean

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:142


toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:137


unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:145