Notebook

Extends

• Entity

Constructors

new Notebook()

new Notebook(dart): Notebook

Parameters

Parameter	Type
dart	any

Returns

Notebook

Overrides

Entity . constructor

Constructs

Notebook

Source

src/entities.ts:834

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:125

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:116

---

description

get description(): string

Description

set description(e): void

Parameters

Parameter	Type
e	string

Returns

string

Source

src/entities.ts:843

---

entityType

get entityType(): string

Entity type name *

Returns

string

Source

src/entities.ts:128

---

environment

get environment(): string

Environment name

set environment(e): void

Parameters

Parameter	Type
e	string

Returns

string

Source

src/entities.ts:839

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:102

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:94

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:106

---

notebook

get notebook(): object

set notebook(data): void

Parameters

Parameter	Type
data	object

Returns

object

Source

src/entities.ts:846

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:110

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:113

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:119

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:131

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:143

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:98

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:136

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:146

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:141

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:149