Skip to main content

Module method

Module method 

Source
Expand description

The methods of the contract, all called by the core.

Constants§

ANSWER_PERMISSION
The answer to a permission or a question the harness asked (AnswerPermission, AnswerQuestion → Writes).
ANSWER_QUESTION
ATTACH
An agent given to the plugin, before its launch and again after a restart (Attach).
CLOSE
The agent stops using its shared harness (Close, a call or a notification): gently, its turn finished first and Item::Closed said once it is; or at once, its turn stopped.
COMPACT
Compact its context (Compact → Compacted), as Engine::compaction says it can.
CONTROL
A request in the harness’s own protocol, its answer: for the tests, and what has no method yet (Control).
DETACH
The agent’s process is gone: its state may be dropped (a notification, AgentRef).
FRAMES
What the harness wrote, in a batch of raw lines (Frames → Items).
INTERRUPT
Stop the running turn (Interrupt → Writes).
ITEMS
From the plugin, without being asked (a notification, Pushed): what its harness said by a way only the plugin reads (the event stream of a shared server).
LAUNCH
Stateless: the description of a harness’s launch for an agent (LaunchParams → Launch).
LET_GO
The agent was the last in its folder: its shared harness lets that folder go (AgentRef).
ONE_SHOT
Stateless: the launch of a one-shot question (OneShotParams → OneShotLaunch).
ONE_SHOT_READ
Stateless: the answer of a one-shot question, from what its process wrote (OneShotOutput → OneShotText).
OPEN
A harness shared by agents (Launch::shared): the agent’s session opened on it (Open → Opened).
PROGRAM_GONE
Its program ended by itself, for a harness that declares relaunches (Gone → Items): Item::Relaunch goes on with another, Item::Stop says why not, nothing ends the agent’s process.
READ_USAGE
The quota of the agent’s account, as its process reads it (AgentRef → Usage).
REMOTE
Link its session to its vendor’s site, or end the link (RemoteLink → Asked).
RENAME
Give its session a title (SetValue).
SEND_MESSAGE
A message to send (SendMessage → Writes).
SET_EFFORT
SET_MODE
SET_MODEL
A change of model, effort or mode (SetValue → Writes).
STOP_TASK
Stop one of its background tasks (Task → Asked).
TASK_OUTPUT
What a background task wrote so far (Task → Asked).
TERMINAL_HOOK
One of its hooks, with what the core answers it (Hook → HookAnswer).
TERMINAL_LAUNCH
The launch of the harness’s own interface in a terminal (TerminalParams → Launch).