Class Icon

Hierarchy

StreamModel
- Icon

Indexable

[x: string]: any

Index

Constructors

constructor

new Icon(): Icon
Returns Icon
Overrides StreamModel.constructor
- Defined in src/models/icon.ts:10

Properties

edges

edges: OntologyEdge[] = []

expand

expand: number

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Static`attributes

attributes: never[] = []

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/icon'

`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

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
Inherited from StreamModel.addChildrenToStore
- Defined in src/models/model.ts:73

addEdge

addEdge(edge: OntologyEdge): void
Parameters
- edge: OntologyEdge
Returns void
Inherited from StreamModel.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 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

cancelOnChange

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

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

clearAllCallbacks

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

clearTags

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

create

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

createEdge

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

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

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

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/icon.ts:15

getClass

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

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

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

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>
Inherited from StreamModel.loadAllChildren
- Defined in src/models/model.ts:198

onChange

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

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

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
Inherited from StreamModel.parseChild
- Defined in src/models/model.ts:267

path

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

preserve

preserve(): void
Returns void
Inherited from StreamModel.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 StreamModel.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 StreamModel.reloadAndParse
- Defined in src/models/model.ts:205

removeChild

removeChild(_: IModel): void
Parameters
- _: IModel
Returns void
Inherited from StreamModel.removeChild
- Defined in src/models/model.ts:66

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

restore

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

setParent

setParent(parent?: IModel): void
Parameters
- Optionalparent: IModel
Returns void
Inherited from StreamModel.setParent
- Defined in src/models/model.ts:77

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

toJSON

toJSON(customKeys?: string[]): JSONObject
Parameters
- OptionalcustomKeys: string[]
Returns JSONObject
Inherited from StreamModel.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 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<Icon[]>
Returns Promise<Icon[]>
Overrides StreamModel.fetch
- Defined in src/models/icon.ts:38

`Static`fetchById

fetchById(id: string): Promise<undefined | Icon>
Parameters
- id: string
Returns Promise<undefined | Icon>
- Defined in src/models/icon.ts:23

`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`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 Icon

Hierarchy

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Icon

Properties

edges

expand

meta

Optionalparent

parentEdges

Staticattributes

Staticchecker

Staticendpoint

StaticstreamCallback

Accessors

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>

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>

createEdge

Parameters

Returns Promise<OntologyEdge>

delete

Returns Promise<void>

deleteBranch

Returns Promise<void>

deleteEdge

Parameters

Returns Promise<void>

deleteEdges

Returns Promise<void>

deleteModelFromEdge

Parameters

Returns Promise<void>

findEdge

Parameters

`Optional`parent

`Static`attributes

`Static`checker

`Static`endpoint

`Static`streamCallback