Class Network

Hierarchy

ConnectionModel
- Network

Implements

INetwork

Indexable

[x: string]: any

Index

Constructors

constructor

new Network(name?: string): Network
Parameters
- Optionalname: string
Returns Network
Overrides ConnectionModel.constructor
- Defined in src/models/network.ts:52

Properties

`Optional`description

description?: string

device

device: Device[] = []

edges

edges: OntologyEdge[] = []

expand

expand: number

name

name: string

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Static`attributes

attributes: string[] = ...

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/network'

`Static`streamCallback

streamCallback: StreamHandlerCallbacks = ...

Accessors

devices

get devices(): Device[]
Returns Device[]
- Defined in src/models/network.ts:48

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 ConnectionModel.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 ConnectionModel.ontology
- Defined in src/models/model.ontology.ts:42

Methods

_create

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

addChildrenToStore

addChildrenToStore(): void
Returns void
Overrides ConnectionModel.addChildrenToStore
- Defined in src/models/network.ts:90

addEdge

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

addParentEdge

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

addTag

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

cancelOnChange

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

cancelOnConnectionChange

cancelOnConnectionChange(callback: ConnectionCallback): Promise<void>
Parameters
- callback: ConnectionCallback
Returns Promise<void>
Inherited from ConnectionModel.cancelOnConnectionChange
- Defined in src/models/model.connection.ts:42

cancelOnCreate

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

cancelOnDelete

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

cancelOnEvent

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

clearAllCallbacks

clearAllCallbacks(): Promise<boolean>
Returns Promise<boolean>
Inherited from ConnectionModel.clearAllCallbacks
- Defined in src/models/model.stream.ts:245

clearTags

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

create

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

createDevice

createDevice(params: IDevice): Promise<Device>
Parameters
- params: IDevice
Returns Promise<Device>
- Defined in src/models/network.ts:220

createEdge

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

delete

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

deleteBranch

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

deleteEdge

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

deleteEdges

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

deleteModelFromEdge

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

findDeviceByName

findDeviceByName(name: string): Device[]
Parameters
- name: string
Returns Device[]
- Defined in src/models/network.ts:99

findDeviceByProduct

findDeviceByProduct(product: string): Device[]
Parameters
- product: string
Returns Device[]
- Defined in src/models/network.ts:104

findEdge

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

findEdges

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

findValueByName

findValueByName(name: string): Value[]
Parameters
- name: string
Returns Value[]
- Defined in src/models/network.ts:109

findValueByType

findValueByType(type: string): Value[]
Parameters
- type: string
Returns Value[]
- Defined in src/models/network.ts:118

getAllEdges

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

getAttributes

getAttributes(): string[]
Returns string[]
Overrides ConnectionModel.getAttributes
- Defined in src/models/network.ts:58

getClass

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

getParent

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

getParentEdges

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

getSharedWith

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

getTags

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

getType

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

getUrl

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

getVersion

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

handleStream

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

id

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

isOnline

isOnline(): boolean
Returns boolean
Inherited from ConnectionModel.isOnline
- Defined in src/models/model.connection.ts:10

loadAllChildren

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

onChange

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

onConnectionChange

onConnectionChange(callback: ConnectionCallback): Promise<boolean>
Parameters
- callback: ConnectionCallback
Returns Promise<boolean>
Inherited from ConnectionModel.onConnectionChange
- Defined in src/models/model.connection.ts:17

onCreate

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

onDelete

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

onEvent

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

parse

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

parseChild

parseChild(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Overrides ConnectionModel.parseChild
- Defined in src/models/network.ts:250

path

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

preserve

preserve(): void
Returns void
Inherited from ConnectionModel.preserve
- Defined in src/models/model.ts:87

reload

reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- OptionaldefaultExpand: number
Returns Promise<boolean>
Inherited from ConnectionModel.reload
- Defined in src/models/model.permission.ts:267

reloadAndParse

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

removeChild

removeChild(child: IModel): void
Parameters
- child: IModel
Returns void
Overrides ConnectionModel.removeChild
- Defined in src/models/network.ts:260

removeEdge

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

removeParentEdge

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

removeTag

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

restore

restore(): void
Returns void
Inherited from ConnectionModel.restore
- Defined in src/models/model.ts:90

setParent

setParent(parent: undefined | IModel): void
Parameters
- parent: undefined | IModel
Returns void
Overrides ConnectionModel.setParent
- Defined in src/models/network.ts:266

shareWith

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

toJSON

toJSON(customKeys?: string[]): JSONObject
Parameters
- OptionalcustomKeys: string[]
Returns JSONObject
Inherited from ConnectionModel.toJSON
- Defined in src/models/model.ts:271

transverse

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

unshareWith

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

update

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

url

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

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Inherited from ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.cancelOnDelete
- Defined in src/models/model.stream.ts:152

`Static`fetch

fetch(): Promise<Network[]>
Returns Promise<Network[]>
Overrides ConnectionModel.fetch
- Defined in src/models/network.ts:469

`Static`fetchById

fetchById(id: string): Promise<undefined | Network>
Parameters
- id: string
Returns Promise<undefined | Network>
- Defined in src/models/network.ts:413

`Static`fetchByName

fetchByName(name?: string): Promise<Network[]>
Parameters
- name: string = ''
Returns Promise<Network[]>
- Defined in src/models/network.ts:436

`Static`find

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

`Static`findAllByFilter

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

`Static`findAllByName

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

`Static`findByFilter

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

`Static`findById

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

`Static`findByName

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

`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 ConnectionModel.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

generateOptions(params?: JSONObject): JSONObject
Parameters
- Optionalparams: JSONObject
Returns JSONObject
Inherited from ConnectionModel.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/network.ts:62

`Static`getFilterResult

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

`Static`getMetaFilterResult

getMetaFilterResult(_filter?: Filter): string
Parameters
- Optional_filter: Filter
Returns string
Inherited from ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.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 ConnectionModel.validateMethod
- Defined in src/models/model.ts:352

Class Network

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Network

Properties

Optionaldescription

device

edges

expand

meta

name

Optionalparent

parentEdges

Staticattributes

Staticchecker

Staticendpoint

StaticstreamCallback

Accessors

devices

Returns Device[]

ontology

Returns OntologyEdge[]

Remarks

Deprecated

Parameters

Returns void

Remarks

Deprecated

Methods

_create

Parameters

Returns Promise<void>

addChildrenToStore

Returns void

addEdge

Parameters

Returns void

addParentEdge

Parameters

Returns Promise<void>

addTag

Parameters

Returns Promise<boolean>

cancelOnChange

Parameters

Returns Promise<boolean>

cancelOnConnectionChange

Parameters

Returns Promise<void>

cancelOnCreate

Parameters

Returns Promise<boolean>

cancelOnDelete

Parameters

Returns Promise<boolean>

cancelOnEvent

Parameters

Returns Promise<boolean>

clearAllCallbacks

Returns Promise<boolean>

clearTags

Returns Promise<boolean>

create

Returns Promise<void>

createDevice

Parameters

Returns Promise<Device>

createEdge

Parameters

Returns Promise<OntologyEdge>

delete

`Optional`description

`Optional`parent

`Static`attributes

`Static`checker

`Static`endpoint

`Static`streamCallback