Skip to main content

IActor

The core interface for all actors in ControlBee.

Namespace: ControlBee.Interfaces

Properties

NameTypeDescription
NamestringThe unique name of the actor.
TitlestringThe display title of the actor.

Methods

Send

Sends a message to the actor.

Guid Send(Message message);

Returns: A Guid identifying the sent message.

GetItems

Returns all items exposed by the actor.

(string itemPath, Type type)[] GetItems();

Returns: An array of tuples containing each item's path and type.

GetItem

Retrieves a specific item by its path.

IActorItem? GetItem(string itemPath);

Returns: The IActorItem if found, or null.

GetFunctions

Lists the names of all functions available on the actor.

string[] GetFunctions();

GetAxisItemPaths

Returns the axis item paths associated with a given position item.

string[] GetAxisItemPaths(string positionItemPath);

Parameters:

  • positionItemPath — The path of the position item.