Skip to main content

Class: ComponentInformationEvent

Defined in: src/common/web/api/component/ComponentEvents.ts:28

Contains information about a connected component; this is automatically sent whenever a connection is established (bilaterally).

Param​

The component ID.

Param​

The component name.

Param​

The component version.

Param​

The API protocol version.

Extends​

Constructors​

Constructor​

new ComponentInformationEvent(name, origin, sender, target, hops, trace, apiKey): ComponentInformationEvent

Defined in: src/common/web/core/messaging/Message.ts:63

Parameters​

name​

string

The name of the message.

origin​

UnitID

The initial source component of the message.

sender​

UnitID

The component from where the message came from.

target​

Channel

Where the message should go to.

hops​

UnitID[] = []

A list of components the message was sent through.

trace​

string = ...

A unique trace identifying messages that logically belong together.

apiKey​

string = ""

An optional API key to access protected resources.

Returns​

ComponentInformationEvent

Inherited from​

Event.constructor

Properties​

api_key​

readonly api_key: string = ""

Defined in: src/common/web/core/messaging/Message.ts:50

Inherited from​

Event.api_key

api_protocol​

readonly api_protocol: string

Defined in: src/common/web/api/component/ComponentEvents.ts:36

comp_id​

readonly comp_id: UnitID

Defined in: src/common/web/api/component/ComponentEvents.ts:31

comp_name​

readonly comp_name: string = ""

Defined in: src/common/web/api/component/ComponentEvents.ts:33

comp_version​

readonly comp_version: string = ""

Defined in: src/common/web/api/component/ComponentEvents.ts:34

hops​

readonly hops: UnitID[] = []

Defined in: src/common/web/core/messaging/Message.ts:46

Inherited from​

Event.hops

name​

readonly name: string

Defined in: src/common/web/core/messaging/Message.ts:33

Inherited from​

Event.name

origin​

readonly origin: UnitID

Defined in: src/common/web/core/messaging/Message.ts:36

Inherited from​

Event.origin

payload​

readonly payload: MessagePayload

Defined in: src/common/web/core/messaging/Message.ts:52

Inherited from​

Event.payload

sender​

readonly sender: UnitID

Defined in: src/common/web/core/messaging/Message.ts:39

Inherited from​

Event.sender

target​

readonly target: Channel

Defined in: src/common/web/core/messaging/Message.ts:42

Inherited from​

Event.target

trace​

readonly trace: string = ""

Defined in: src/common/web/core/messaging/Message.ts:48

Inherited from​

Event.trace

Category​

readonly static Category: string = "Event"

Defined in: src/common/web/core/messaging/Event.ts:9

Inherited from​

Event.Category

Accessors​

messageCategory​

Get Signature​

get messageCategory(): string

Defined in: src/common/web/core/messaging/Event.ts:14

Gets the global message category.

Returns​

string

Inherited from​

Event.messageCategory

Methods​

componentInformation()​

componentInformation(): ComponentInformation

Defined in: src/common/web/api/component/ComponentEvents.ts:43

The component information bundled as an object.

Returns​

ComponentInformation

  • The component information stored in a ComponentInformation object.

convertToJSON()​

convertToJSON(): string

Defined in: src/common/web/core/messaging/Message.ts:76

Converts this message to JSON.

Returns​

string

Inherited from​

Event.convertToJSON

toString()​

toString(): string

Defined in: src/common/web/core/messaging/Message.ts:154

Gets the string representation of this message.

Returns​

string

Inherited from​

Event.toString

build()​

static build(messageBuilder, compID, compName, compVersion, chain): EventComposer<ComponentInformationEvent>

Defined in: src/common/web/api/component/ComponentEvents.ts:54

Helper function to easily build this message.

Parameters​

messageBuilder​

MessageBuilder

compID​

UnitID

compName​

string

compVersion​

string

chain​

null | Message

Returns​

EventComposer<ComponentInformationEvent>

convertFromJSON()​

static convertFromJSON(msgType, data): Message

Defined in: src/common/web/core/messaging/Message.ts:93

Creates a message from JSON data.

Parameters​

msgType​

ConstructableMessage

The message type to construct.

data​

string

The JSON data string.

Returns​

Message

  • The created message.

Inherited from​

Event.convertFromJSON

define()​

static define(name): Function

Defined in: src/common/web/core/messaging/Message.ts:128

Defines a new message.

The decorator takes care of wrapping the new class as a dataclass, passing the correct message name to its constructor. It also registers the new message type in the global MessageTypesCatalog.

Examples:

    @Message.define("msg/command")
    class MyCommand extends Command {
        ...
    }

Parameters​

name​

string

The name of the message.

Returns​

Function

Inherited from​

Event.define

isProtected()​

static isProtected(): boolean

Defined in: src/common/web/core/messaging/Message.ts:108

The frontend never receives or issues protected messages.

Returns​

boolean

Inherited from​

Event.isProtected

messageName()​

static messageName(): string

Defined in: src/common/web/core/messaging/Message.ts:101

Retrieves the name of the message type on a message class basis.

Returns​

string

Inherited from​

Event.messageName