Class Network

edges

expand

meta

Optionalparent

parentEdges

Staticchecker

StaticstreamCallback

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.

• 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.

_create

• _create(params?: JSONObject): Promise<void>

• Parameters

  • params: JSONObject = {}

  Returns Promise<void>

addEdge

• addEdge(edge: OntologyEdge): void

• Parameters

  • edge: OntologyEdge

  Returns void

addParentEdge

• addParentEdge(params: IOntologyEdge, to: IOntologyModel): Promise<void>

• Parameters

  • params: IOntologyEdge
  • to: IOntologyModel

  Returns Promise<void>

addTag

• addTag(tag: string): Promise<boolean>

• Parameters

  • tag: string

  Returns Promise<boolean>

cancelOnChange

• cancelOnChange(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

cancelOnConnectionChange

• cancelOnConnectionChange(callback: ConnectionCallback): Promise<void>

• Parameters

  • callback: ConnectionCallback

  Returns Promise<void>

cancelOnCreate

• cancelOnCreate(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

cancelOnDelete

• cancelOnDelete(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

cancelOnEvent

• cancelOnEvent(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

clearAllCallbacks

• clearAllCallbacks(): Promise<boolean>

• Returns Promise<boolean>

clearTags

• clearTags(): Promise<boolean>

• Returns Promise<boolean>

create

• create(): Promise<void>

• Returns Promise<void>

createEdge

• createEdge(params: IEdge): Promise<OntologyEdge>

• Parameters

  • params: IEdge

  Returns Promise<OntologyEdge>

delete

• delete(): Promise<void>

• Returns Promise<void>

deleteBranch

• deleteBranch(): Promise<void>

• Returns Promise<void>

deleteEdge

• deleteEdge(params: IEdge): Promise<void>

• Parameters

  • params: IEdge

  Returns Promise<void>

deleteEdges

• deleteEdges(): Promise<void>

• Returns Promise<void>

deleteModelFromEdge

• deleteModelFromEdge(params: IEdge): Promise<void>

• Parameters

  • params: IEdge

  Returns Promise<void>

findEdge

• findEdge(params: IEdge): Promise<undefined | OntologyEdge>

• Parameters

  • params: IEdge

  Returns Promise<undefined | OntologyEdge>

findEdges

• findEdges(relationship: string): Promise<OntologyEdge[]>

• Parameters

  • relationship: string

  Returns Promise<OntologyEdge[]>

getAllEdges

• getAllEdges(_force?: boolean): Promise<IOntologyEdge[]>

• Parameters

  • Optional_force: boolean

  Returns Promise<IOntologyEdge[]>

getClass

• getClass(): string

• Returns string

getParent

• getParent(): undefined | IModel

• Returns undefined | IModel

getParentEdges

• getParentEdges(): IOntologyEdge[]

• Returns IOntologyEdge[]

getSharedWith

• getSharedWith(): Promise<any>

• Returns Promise<any>

getTags

• getTags(): string[]

• Returns string[]

getType

• getType(): string

• Returns string

getUrl

• getUrl(): string

• Returns string

getVersion

• getVersion(): string

• Returns string

handleStream

• handleStream(event: StreamEvent): Promise<void>

• Parameters

  • event: StreamEvent

  Returns Promise<void>

id

• id(): string

• Returns string

isOnline

• isOnline(): boolean

• Returns boolean

onChange

• onChange(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

onConnectionChange

• onConnectionChange(callback: ConnectionCallback): Promise<boolean>

• Parameters

  • callback: ConnectionCallback

  Returns Promise<boolean>

onCreate

• onCreate(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

onDelete

• onDelete(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

onEvent

• onEvent(callback: StreamCallback): Promise<boolean>

• Parameters

  • callback: StreamCallback

  Returns Promise<boolean>

parse

• parse(json: JSONObject): boolean

• Parameters

  • json: JSONObject

  Returns boolean

path

• path(): string

• Returns string

preserve

• preserve(): void

• Returns void

reload

• reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>

• Parameters

  • OptionalreloadAll: boolean
  • OptionaldefaultExpand: number

  Returns Promise<boolean>

reloadAndParse

• reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>

• Parameters

  • OptionalreloadAll: boolean
  • defaultExpand: number = 0

  Returns Promise<boolean>

removeEdge

• removeEdge(edge: IModel): void

• Parameters

  • edge: IModel

  Returns void

removeParentEdge

• removeParentEdge(edge: IOntologyEdge): void

• Parameters

  • edge: IOntologyEdge

  Returns void

removeTag

• removeTag(tag: string): Promise<boolean>

• Parameters

  • tag: string

  Returns Promise<boolean>

restore

• restore(): void

• Returns void

shareWith

• shareWith(user: string, restriction?: IRestriction): Promise<any>

• Parameters

  • user: string
  • restriction: IRestriction = ...

  Returns Promise<any>

toJSON

• toJSON(customKeys?: string[]): JSONObject

• Parameters

  • OptionalcustomKeys: string[]

  Returns JSONObject

transverse

• transverse(path: string, getAll?: boolean): Promise<IOntologyModel[]>

• Parameters

  • path: string
  • OptionalgetAll: boolean

  Returns Promise<IOntologyModel[]>

unshareWith

• unshareWith(user: string): Promise<any>

• Parameters

  • user: string

  Returns Promise<any>

update

• update(customKeys?: string[]): Promise<boolean>

• Parameters

  • OptionalcustomKeys: string[]

  Returns Promise<boolean>

url

• url(): string

• Returns string

StaticcancelCallback

• cancelCallback(
      all: StreamHandlerCallbacks,
      type: "create" | "update" | "delete",
      callback: StreamHandler,
  ): Promise<boolean>

• Parameters

  • all: StreamHandlerCallbacks
  • type: "create" | "update" | "delete"
  • callback: StreamHandler

  Returns Promise<boolean>

StaticcancelOnChange

• cancelOnChange<T>(this: new () => T, callback: StreamCallback): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamCallback

  Returns Promise<boolean>

StaticcancelOnCreate

• cancelOnCreate<T>(this: new () => T, callback: StreamCallback): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamCallback

  Returns Promise<boolean>

StaticcancelOnDelete

• cancelOnDelete<T>(this: new () => T, callback: StreamCallback): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamCallback

  Returns Promise<boolean>

StaticfromArray

• 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)[]

StaticgetMetaFilterResult

• getMetaFilterResult(_filter?: Filter): string

• Parameters

  • Optional_filter: Filter

  Returns string

StaticonChange

• onChange<T>(this: new () => T, callback: StreamHandler): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamHandler

  Returns Promise<boolean>

StaticonCreate

• onCreate<T>(this: new () => T, callback: StreamHandler): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamHandler

  Returns Promise<boolean>

StaticonDelete

• onDelete<T>(this: new () => T, callback: StreamHandler): Promise<boolean>

• Type Parameters

  • T

  Parameters

  • this: new () => T
  • callback: StreamHandler

  Returns Promise<boolean>

Staticrequest

• 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[]>

StaticvalidateMethod

• validateMethod(
      type: undefined | string,
      name: string,
      params: any,
      isStatic?: boolean,
  ): void

• Parameters

  • type: undefined | string
  • name: string
  • params: any
  • isStatic: boolean = false

  Returns void