Cbstate API

The cbstate module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
`addToAgentState`	Adds a key-value pair to the agent's state on the server via WebSocket.
`getAgentState`	Retrieves the current state of the agent from the server via WebSocket.
`getApplicationState`	Retrieves the current application state from the server via WebSocket.
`getProjectState`	Retrieves the current project state from the server via WebSocket.
`updateProjectState`	Updates the project state on the server via WebSocket.

plugin.cbstate.addToAgentState(key: string, value: string): Promise<AddToAgentStateResponse>

Adds a key-value pair to the agent's state on the server via WebSocket.

Parameter	Type	Required	Description
`key`	`string`	Yes	The key to add to the agent's state.
`value`	`string`	Yes	The value associated with the key.

Returns: Promise<AddToAgentStateResponse> — A promise that resolves with the response to the addition request.

plugin.cbstate.getAgentState(): Promise<GetAgentStateResponse>

Retrieves the current state of the agent from the server via WebSocket.

No parameters.

Returns: Promise<GetAgentStateResponse> — A promise that resolves with the agent's state.

plugin.cbstate.getApplicationState(): Promise<ApplicationState>

Retrieves the current application state from the server via WebSocket.

No parameters.

Returns: Promise<ApplicationState> — A promise that resolves with the application state.

plugin.cbstate.getProjectState(): Promise<GetProjectStateResponse>

Retrieves the current project state from the server via WebSocket.

No parameters.

Returns: Promise<GetProjectStateResponse> — A promise that resolves with the project's state.

plugin.cbstate.updateProjectState(key: string, value: any): Promise<UpdateProjectStateResponse>

Updates the project state on the server via WebSocket.

Parameter	Type	Required	Description
`key`	`string`	Yes	The key to update in the project state.
`value`	`any`	Yes	The value to set for the key.

Returns: Promise<UpdateProjectStateResponse> — A promise that resolves with the response to the update request.