Class Value

Hierarchy

StreamModel
- Value

Implements

Indexable

[x: string]: any

Index

Constructors

constructor

new Value(name?: string): Value
Parameters
- Optionalname: string
Returns Value
Overrides StreamModel.constructor
- Defined in src/models/value.ts:107

Properties

`Optional`blob

blob?: IValueStringBlobBase

`Optional`delta

delta?: string

`Optional`description

description?: string

edges

edges: OntologyEdge[] = []

eventlog

eventlog: EventLog[] = []

expand

expand: number

last_period

last_period: number = 0

`Optional`measure_type

measure_type?: string

name

name: string

`Optional`number

number?: IValueNumberBase

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Optional`period

period?: string | number

permission

permission: ValuePermission = 'r'

state

state: State[] = []

`Optional`status

status?: string

`Optional`string

string?: IValueStringBlobBase

`Optional`thresholds

thresholds?: string[]

tmp_permission

tmp_permission: ValuePermission = 'r'

type

type: string = ''

`Optional`xml

xml?: IValueXmlBase

`Static`attributes

attributes: string[] = ...

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/value'

`Static`streamCallback

streamCallback: StreamHandlerCallbacks = ...

Accessors

ontology

get ontology(): OntologyEdge[]
Get the ontology edges of the current object.

Returns OntologyEdge[]
The ontology edges of the current object.

Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
Inherited from StreamModel.ontology
- Defined in src/models/model.ontology.ts:31
set ontology(edges: OntologyEdge[]): void
Set the ontology edges of the current object.
Parameters
- edges: OntologyEdge[]
  The ontology edges to set.
Returns void
Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
Inherited from StreamModel.ontology
- Defined in src/models/model.ontology.ts:42

states

get states(): State[]
Returns State[]
- Defined in src/models/value.ts:113

Methods

_create

_create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from StreamModel._create
- Defined in src/models/model.ts:110

addChildrenToStore

addChildrenToStore(): void
Returns void
Overrides StreamModel.addChildrenToStore
- Defined in src/models/value.ts:198

addEdge

addEdge(edge: OntologyEdge): void
Parameters
- edge: OntologyEdge
Returns void
Inherited from StreamModel.addEdge
- Defined in src/models/model.ontology.ts:50

addEvent

addEvent(
    level: EventLogLevel,
    message: string,
    info?: JSONObject,
): Promise<EventLog>
Parameters
- level: EventLogLevel
- message: string
- Optionalinfo: JSONObject
Returns Promise<EventLog>
Implementation of IValueFunc.addEvent
- Defined in src/models/value.ts:461

addParentEdge

addParentEdge(params: IOntologyEdge, to: IOntologyModel): Promise<void>
Parameters
- params: IOntologyEdge
- to: IOntologyModel
Returns Promise<void>
Inherited from StreamModel.addParentEdge
- Defined in src/models/model.ontology.ts:85

addTag

addTag(tag: string): Promise<boolean>
Parameters
- tag: string
Returns Promise<boolean>
Inherited from StreamModel.addTag
- Defined in src/models/model.tags.ts:5

analyzeEnergy

analyzeEnergy(start: Timestamp, end: Timestamp): Promise<any>
Parameters
- start: Timestamp
- end: Timestamp
Returns Promise<any>
Implementation of IValueFunc.analyzeEnergy
- Defined in src/models/value.ts:988

cancelOnChange

cancelOnChange(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnChange
- Defined in src/models/model.stream.ts:210

cancelOnControl

cancelOnControl(callback?: ValueStreamCallback): Promise<boolean>
Parameters
- Optionalcallback: ValueStreamCallback
Returns Promise<boolean>
- Defined in src/models/value.ts:829

cancelOnCreate

cancelOnCreate(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnCreate
- Defined in src/models/model.stream.ts:218

cancelOnDelete

cancelOnDelete(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnDelete
- Defined in src/models/model.stream.ts:214

cancelOnEvent

cancelOnEvent(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnEvent
- Defined in src/models/model.stream.ts:206

cancelOnRefresh

cancelOnRefresh(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/models/value.ts:833

cancelOnReport

cancelOnReport(callback?: ValueStreamCallback): Promise<boolean>
Parameters
- Optionalcallback: ValueStreamCallback
Returns Promise<boolean>
- Defined in src/models/value.ts:825

cancelPeriod

cancelPeriod(): void
Returns void
- Defined in src/models/value.ts:1215

clearAllCallbacks

clearAllCallbacks(): Promise<boolean>
Returns Promise<boolean>
Overrides StreamModel.clearAllCallbacks
- Defined in src/models/value.ts:1220

clearTags

clearTags(): Promise<boolean>
Returns Promise<boolean>
Inherited from StreamModel.clearTags
- Defined in src/models/model.tags.ts:24

control

control(data: ReportValueInput, timestamp?: Timestamp): Promise<boolean>
Parameters
- data: ReportValueInput
- Optionaltimestamp: Timestamp
Returns Promise<boolean>
Implementation of IValueFunc.control
- Defined in src/models/value.ts:717

controlWithAck

controlWithAck(
data: ReportValueInput,
timestamp?: Timestamp,
): Promise<undefined | null | string>
Parameters
- data: ReportValueInput
- Optionaltimestamp: Timestamp
Returns Promise<undefined | null | string>
Implementation of IValueFunc.controlWithAck
- Defined in src/models/value.ts:722

create

create(): Promise<void>
Returns Promise<void>
Inherited from StreamModel.create
- Defined in src/models/model.permission.ts:82

created

created(): Promise<void>
Returns Promise<void>
- Defined in src/models/value.ts:179

createEdge

createEdge(params: IEdge): Promise<OntologyEdge>
Parameters
- params: IEdge
Returns Promise<OntologyEdge>
Inherited from StreamModel.createEdge
- Defined in src/models/model.ontology.ts:55

createState

createState(params: IState): Promise<State>
Parameters
- params: IState
Returns Promise<State>
Implementation of IValueFunc.createState
- Defined in src/models/value.ts:477

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from StreamModel.delete
- Defined in src/models/model.ts:239

deleteBranch

deleteBranch(): Promise<void>
Returns Promise<void>
Inherited from StreamModel.deleteBranch
- Defined in src/models/model.ontology.ts:166

deleteEdge

deleteEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Inherited from StreamModel.deleteEdge
- Defined in src/models/model.ontology.ts:113

deleteEdges

deleteEdges(): Promise<void>
Returns Promise<void>
Inherited from StreamModel.deleteEdges
- Defined in src/models/model.ontology.ts:106

deleteModelFromEdge

deleteModelFromEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Inherited from StreamModel.deleteModelFromEdge
- Defined in src/models/model.ontology.ts:122

deleteState

deleteState(type: StateType): Promise<void>
Parameters
- type: StateType
Returns Promise<void>
Implementation of IValueFunc.deleteState
- Defined in src/models/value.ts:521

energyPieChart

energyPieChart(start: Timestamp, end: Timestamp): Promise<any>
Parameters
- start: Timestamp
- end: Timestamp
Returns Promise<any>
Implementation of IValueFunc.energyPieChart
- Defined in src/models/value.ts:1004

findEdge

findEdge(params: IEdge): Promise<undefined | OntologyEdge>
Parameters
- params: IEdge
Returns Promise<undefined | OntologyEdge>
Inherited from StreamModel.findEdge
- Defined in src/models/model.ontology.ts:152

findEdges

findEdges(relationship: string): Promise<OntologyEdge[]>
Parameters
- relationship: string
Returns Promise<OntologyEdge[]>
Inherited from StreamModel.findEdges
- Defined in src/models/model.ontology.ts:147

forceReport

forceReport(data: ReportValueInput, timestamp?: Timestamp): Promise<boolean>
Parameters
- data: ReportValueInput
- Optionaltimestamp: Timestamp
Returns Promise<boolean>
Implementation of IValueFunc.forceReport
- Defined in src/models/value.ts:616

getAllEdges

getAllEdges(_force?: boolean): Promise<IOntologyEdge[]>
Parameters
- Optional_force: boolean
Returns Promise<IOntologyEdge[]>
Inherited from StreamModel.getAllEdges
- Defined in src/models/model.ontology.ts:192

getAttributes

getAttributes(): string[]
Returns string[]
Overrides StreamModel.getAttributes
- Defined in src/models/value.ts:117

getClass

getClass(): string
Returns string
Inherited from StreamModel.getClass
- Defined in src/models/model.ts:57

getControlData

getControlData(): undefined | string
Returns undefined | string
- Defined in src/models/value.ts:570

getControlLog

getControlLog(request: LogRequest): Promise<ILogResponse>
Parameters
- request: LogRequest
Returns Promise<ILogResponse>
Implementation of IValueFunc.getControlLog
- Defined in src/models/value.ts:968

getControlTimestamp

getControlTimestamp(): undefined | string
Returns undefined | string
- Defined in src/models/value.ts:574

getParent

getParent(): undefined | IModel
Returns undefined | IModel
Inherited from StreamModel.getParent
- Defined in src/models/model.ts:82

getParentEdges

getParentEdges(): IOntologyEdge[]
Returns IOntologyEdge[]
Inherited from StreamModel.getParentEdges
- Defined in src/models/model.ontology.ts:46

getReportData

getReportData(): undefined | string
Returns undefined | string
- Defined in src/models/value.ts:566

getReportLog

getReportLog(request: LogRequest): Promise<ILogResponse>
Parameters
- request: LogRequest
Returns Promise<ILogResponse>
Implementation of IValueFunc.getReportLog
- Defined in src/models/value.ts:962

getReportTimestamp

getReportTimestamp(): undefined | string
Returns undefined | string
- Defined in src/models/value.ts:578

getSharedWith

getSharedWith(): Promise<any>
Returns Promise<any>
Inherited from StreamModel.getSharedWith
- Defined in src/models/model.sharing.ts:51

getTags

getTags(): string[]
Returns string[]
Inherited from StreamModel.getTags
- Defined in src/models/model.tags.ts:20

getType

getType(): string
Returns string
Inherited from StreamModel.getType
- Defined in src/models/model.ts:41

getUrl

getUrl(): string
Returns string
Inherited from StreamModel.getUrl
- Defined in src/models/model.ts:101

getValueType

getValueType(): string
Returns string
- Defined in src/models/value.ts:146

getVersion

getVersion(): string
Returns string
Inherited from StreamModel.getVersion
- Defined in src/models/model.ts:45

handleStream

handleStream(event: StreamEvent): Promise<void>
Parameters
- event: StreamEvent
Returns Promise<void>
Inherited from StreamModel.handleStream
- Defined in src/models/model.stream.ts:295

id

id(): string
Returns string
Inherited from StreamModel.id
- Defined in src/models/model.ts:37

loadAllChildren

loadAllChildren(json: null | JSONObject, reloadAll?: boolean): Promise<void>
Parameters
- json: null | JSONObject
- reloadAll: boolean = false
Returns Promise<void>
Overrides StreamModel.loadAllChildren
- Defined in src/models/value.ts:278

onChange

onChange(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.onChange
- Defined in src/models/model.stream.ts:173

onControl

onControl(
callback: ValueStreamCallback,
forceRegistering?: boolean,
): Promise<boolean>
Parameters
- callback: ValueStreamCallback
- OptionalforceRegistering: boolean
Returns Promise<boolean>
Implementation of IValueFunc.onControl
- Defined in src/models/value.ts:775

onCreate

onCreate(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.onCreate
- Defined in src/models/model.stream.ts:195

onDelete

onDelete(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.onDelete
- Defined in src/models/model.stream.ts:184

onEvent

onEvent(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.onEvent
- Defined in src/models/model.stream.ts:162

onRefresh

onRefresh(callback: RefreshStreamCallback): Promise<boolean>
Parameters
- callback: RefreshStreamCallback
Returns Promise<boolean>
Implementation of IValueFunc.onRefresh
- Defined in src/models/value.ts:801

onReport

onReport(
    callback: ValueStreamCallback,
    callOnInit?: boolean,
    forceRegistering?: boolean,
): Promise<boolean>
Parameters
- callback: ValueStreamCallback
- OptionalcallOnInit: boolean
- OptionalforceRegistering: boolean
Returns Promise<boolean>
Implementation of IValueFunc.onReport
- Defined in src/models/value.ts:787

parse

parse(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from StreamModel.parse
- Defined in src/models/model.ts:252

parseChild

parseChild(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Overrides StreamModel.parseChild
- Defined in src/models/value.ts:540

path

path(): string
Returns string
Inherited from StreamModel.path
- Defined in src/models/model.ts:53

preserve

preserve(): void
Returns void
Overrides StreamModel.preserve
- Defined in src/models/value.ts:190

refresh

refresh(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/models/value.ts:858

reload

reload(_reloadAll?: boolean): Promise<boolean>
Parameters
- _reloadAll: boolean = false
Returns Promise<boolean>
Overrides StreamModel.reload
- Defined in src/models/value.ts:274

reloadAndParse

reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from StreamModel.reloadAndParse
- Defined in src/models/model.ts:205

removeChild

removeChild(child: IModel): void
Parameters
- child: IModel
Returns void
Overrides StreamModel.removeChild
- Defined in src/models/value.ts:515

removeEdge

removeEdge(edge: IModel): void
Parameters
- edge: IModel
Returns void
Inherited from StreamModel.removeEdge
- Defined in src/models/model.ontology.ts:136

removeParentEdge

removeParentEdge(edge: IOntologyEdge): void
Parameters
- edge: IOntologyEdge
Returns void
Inherited from StreamModel.removeParentEdge
- Defined in src/models/model.ontology.ts:100

removeTag

removeTag(tag: string): Promise<boolean>
Parameters
- tag: string
Returns Promise<boolean>
Inherited from StreamModel.removeTag
- Defined in src/models/model.tags.ts:11

removeValueType

removeValueType(oldType: string): void
Parameters
- oldType: string
Returns void
- Defined in src/models/value.ts:162

report

report(
data: ReportValueInput | LogValues,
timestamp?: Timestamp,
): Promise<boolean>
Parameters
- data: ReportValueInput | LogValues
- Optionaltimestamp: Timestamp
Returns Promise<boolean>
Implementation of IValueFunc.report
- Defined in src/models/value.ts:603

restore

restore(): void
Returns void
Overrides StreamModel.restore
- Defined in src/models/value.ts:194

setDelta

setDelta(delta: number): Promise<boolean>
Parameters
- delta: number
Returns Promise<boolean>
- Defined in src/models/value.ts:866

setParent

setParent(parent?: IModel): void
Parameters
- Optionalparent: IModel
Returns void
Overrides StreamModel.setParent
- Defined in src/models/value.ts:207

setPeriod

setPeriod(period: number): Promise<boolean>
Parameters
- period: number
Returns Promise<boolean>
- Defined in src/models/value.ts:862

shareWith

shareWith(user: string, restriction?: IRestriction): Promise<any>
Parameters
- user: string
- restriction: IRestriction = ...
Returns Promise<any>
Inherited from StreamModel.shareWith
- Defined in src/models/model.sharing.ts:7

summarizeEnergy

summarizeEnergy(start: Timestamp, end: Timestamp): Promise<any>
Parameters
- start: Timestamp
- end: Timestamp
Returns Promise<any>
Implementation of IValueFunc.summarizeEnergy
- Defined in src/models/value.ts:996

toJSON

toJSON(): JSONObject
Returns JSONObject
Overrides StreamModel.toJSON
- Defined in src/models/value.ts:532

transverse

transverse(path: string, getAll?: boolean): Promise<IOntologyModel[]>
Parameters
- path: string
- OptionalgetAll: boolean
Returns Promise<IOntologyModel[]>
Inherited from StreamModel.transverse
- Defined in src/models/model.ontology.ts:207

unshareWith

unshareWith(user: string): Promise<any>
Parameters
- user: string
Returns Promise<any>
Inherited from StreamModel.unshareWith
- Defined in src/models/model.sharing.ts:39

update

update(customKeys?: string[]): Promise<boolean>
Parameters
- OptionalcustomKeys: string[]
Returns Promise<boolean>
Inherited from StreamModel.update
- Defined in src/models/model.ts:179

url

url(): string
Returns string
Inherited from StreamModel.url
- Defined in src/models/model.ts:49

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Inherited from StreamModel.usePutForUpdate
- Defined in src/models/model.ts:61

`Protected`validate

validate(name: string, params: any): void
Parameters
- name: string
- params: any
Returns void
Inherited from StreamModel.validate
- Defined in src/models/model.ts:97

`Static`cancelCallback

cancelCallback(
    all: StreamHandlerCallbacks,
    type: "create" | "update" | "delete",
    callback: StreamHandler,
): Promise<boolean>
Parameters
- all: StreamHandlerCallbacks
- type: "create" | "update" | "delete"
- callback: StreamHandler
Returns Promise<boolean>
Inherited from StreamModel.cancelCallback
- Defined in src/models/model.stream.ts:105

`Static`cancelOnChange

cancelOnChange<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnChange
- Defined in src/models/model.stream.ts:142

`Static`cancelOnCreate

cancelOnCreate<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnCreate
- Defined in src/models/model.stream.ts:132

`Static`cancelOnDelete

cancelOnDelete<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from StreamModel.cancelOnDelete
- Defined in src/models/model.stream.ts:152

`Static`fetch

fetch(): Promise<Value[]>
Returns Promise<Value[]>
Overrides StreamModel.fetch
- Defined in src/models/value.ts:238

`Static`fetchById

fetchById(id: string): Promise<undefined | Value>
Parameters
- id: string
Returns Promise<undefined | Value>
- Defined in src/models/value.ts:216

`Static`find

find(
    params: JSONObject,
    quantity?: number | "all",
    readOnly?: boolean,
    usage?: string,
    filterRequest?: JSONObject,
): Promise<Value[]>
Parameters
- params: JSONObject
- quantity: number | "all" = 1
- readOnly: boolean = false
- usage: string = ''
- OptionalfilterRequest: JSONObject
Returns Promise<Value[]>
- Defined in src/models/value.ts:1012

`Static`findAllByFilter

findAllByFilter(
    filter: Filter,
    omit_filter?: Filter,
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- filter: Filter
- omit_filter: Filter = {}
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1145

`Static`findAllByName

findAllByName(
    name: string,
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- name: string
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1100

`Static`findAllByType

findAllByType(
    type: string,
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- type: string
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1105

`Static`findByFilter

findByFilter(
    filter: Filter,
    omit_filter?: Filter,
    quantity?: number | "all",
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- filter: Filter
- omit_filter: Filter = {}
- quantity: number | "all" = 1
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1121

`Static`findById

findById(id: string, readOnly?: boolean): Promise<Value>
Parameters
- id: string
- readOnly: boolean = false
Returns Promise<Value>
- Defined in src/models/value.ts:1110

`Static`findByName

findByName(
    name: string,
    quantity?: number | "all",
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- name: string
- quantity: number | "all" = 1
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1076

`Static`findByType

findByType(
    type: string,
    quantity?: number | "all",
    readOnly?: boolean,
    usage?: string,
): Promise<Value[]>
Parameters
- type: string
- quantity: number | "all" = 1
- readOnly: boolean = false
- usage: string = ''
Returns Promise<Value[]>
- Defined in src/models/value.ts:1088

`Static`fromArray

fromArray<T>(
    this: new () => T,
    json: JSONObject[],
    parent?: IModel,
): (string | T)[]
Type Parameters
- T
Parameters
- this: new () => T
- json: JSONObject[]
- Optionalparent: IModel
Returns (string | T)[]
Inherited from StreamModel.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

generateOptions(params?: JSONObject): JSONObject
Parameters
- Optionalparams: JSONObject
Returns JSONObject
Inherited from StreamModel.generateOptions
- Defined in src/models/model.ts:384

`Static`getFilter

getFilter(filter?: Filter, omit_filter?: Filter): string[]
Parameters
- Optionalfilter: Filter
- Optionalomit_filter: Filter
Returns string[]
- Defined in src/models/value.ts:121

`Static`getFilterResult

getFilterResult(filter?: Filter, omit_filter?: Filter): string
Parameters
- Optionalfilter: Filter
- Optionalomit_filter: Filter
Returns string
- Defined in src/models/value.ts:131

`Static`getMetaFilterResult

getMetaFilterResult(_filter?: Filter): string
Parameters
- Optional_filter: Filter
Returns string
Inherited from StreamModel.getMetaFilterResult
- Defined in src/models/model.ts:93

`Static`onChange

onChange<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from StreamModel.onChange
- Defined in src/models/model.stream.ts:69

`Static`onCreate

onCreate<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from StreamModel.onCreate
- Defined in src/models/model.stream.ts:51

`Static`onDelete

onDelete<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from StreamModel.onDelete
- Defined in src/models/model.stream.ts:87

`Static`request

request(
    options: {
        body?: JSONObject;
        create?: boolean;
        endpoint: string;
        message: string;
        params?: JSONObject;
        quantity: number | "all";
        readOnly?: boolean;
    },
): Promise<JSONObject[]>
Parameters
- options: {
      body?: JSONObject;
      create?: boolean;
      endpoint: string;
      message: string;
      params?: JSONObject;
      quantity: number | "all";
      readOnly?: boolean;
  }
Returns Promise<JSONObject[]>
Inherited from StreamModel.request
- Defined in src/models/model.permission.ts:141

`Static`validateMethod

validateMethod(
    type: undefined | string,
    name: string,
    params: any,
    isStatic?: boolean,
): void
Parameters
- type: undefined | string
- name: string
- params: any
- isStatic: boolean = false
Returns void
Inherited from StreamModel.validateMethod
- Defined in src/models/model.ts:352

Class Value

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Value

Properties

Optionalblob

Optionaldelta

Optionaldescription

edges

eventlog

expand

last_period

Optionalmeasure_type

meta

name

Optionalnumber

Optionalparent

parentEdges

Optionalperiod

permission

state

Optionalstatus

Optionalstring

Optionalthresholds

tmp_permission

type

Optionalxml

Staticattributes

Staticchecker

Staticendpoint

StaticstreamCallback

Accessors

ontology

Returns OntologyEdge[]

Remarks

Deprecated

Parameters

Returns void

Remarks

Deprecated

states

Returns State[]

Methods

_create

Parameters

Returns Promise<void>

addChildrenToStore

Returns void

addEdge

Parameters

Returns void

addEvent

Parameters

Returns Promise<EventLog>

addParentEdge

Parameters

Returns Promise<void>

addTag

Parameters

Returns Promise<boolean>

analyzeEnergy

Parameters

Returns Promise<any>

cancelOnChange

Parameters

Returns Promise<boolean>

cancelOnControl

Parameters

Returns Promise<boolean>

cancelOnCreate

Parameters

`Optional`blob

`Optional`delta

`Optional`description

`Optional`measure_type

`Optional`number

`Optional`parent

`Optional`period

`Optional`status

`Optional`string

`Optional`thresholds

`Optional`xml

`Static`attributes

`Static`checker

`Static`endpoint

`Static`streamCallback