• Public
  • Public/Protected
  • All

Represents an IO node with IO sources and IO actors for IO routing.

The name of an IO node equals the name of the IO context it is associated with. An IO node also contains node-specific characteristics used by IO routers to manage routes.




Optional characteristics

characteristics?: {}

Node-specific characteristics defined by application (optional).

Can be used by IO routers to manage routes.

Type declaration

  • [key: string]: any


coreType: "IoNode"

The framework core type of the object, i.e. the name of the interface that defines the object's shape.

Optional externalId

externalId?: string

External ID associated with this object (optional)


ioActors: IoActor[]

The IO actors belonging to this IO node.


ioSources: IoSource[]

The IO sources belonging wto this IO node.

Optional isDeactivated

isDeactivated?: boolean

Marks an object that is no longer in use. The concrete definition meaning of this property is defined by the application. The property value is optional and should default to false.

Optional locationId

locationId?: string

Unique ID of Location object that this object has been associated with (optional).


name: string

The name of the IO context, that this IO node is associated with.


objectId: string

Unique ID of the object


objectType: string

The concrete type name of the object.

The name should be in a canonical form following the naming convention for Java packages to avoid name collisions. All framework core types use the form coaty.<InterfaceName>, e.g. coaty.CoatyObject (see constants in CoreTypes class).


Object type names should be made up of characters in the range 0 to 9, a to z, A to Z, and dot (.).


All object types starting with coaty. are reserved for use by the Coaty framework and must not be used by applications to define custom object types.

Optional parentObjectId

parentObjectId?: string

Unique ID of parent/superordinate object (optional)

Generated using TypeDoc