IWaldiezAgentStore
Defined in: src/waldiez/models/Stores/IAgentStore.ts:14
SPDX-License-Identifier: Apache-2.0 Copyright 2024 - 2025 Waldiez & contributors
Properties¶
addAgent()¶
addAgent: (
agentType,position,parentId) =>WaldiezNodeAgent
Defined in: src/waldiez/models/Stores/IAgentStore.ts:35
Add a new agent to the store.
Parameters¶
agentType¶
position¶
x¶
number
y¶
number
parentId¶
string | undefined
Returns¶
The newly added agent.
See¶
addGroupMember()¶
addGroupMember: (
groupId,agentId,position?) =>void
Defined in: src/waldiez/models/Stores/IAgentStore.ts:109
Add a member to a specific group.
Parameters¶
groupId¶
string
agentId¶
string
position?¶
XYPosition
Returns¶
void
cloneAgent()¶
cloneAgent: (
id) =>WaldiezNodeAgent|null
Defined in: src/waldiez/models/Stores/IAgentStore.ts:46
Clone an existing agent.
Parameters¶
id¶
string
Returns¶
WaldiezNodeAgent | null
The cloned agent, or null if the agent was not found.
See¶
deleteAgent()¶
deleteAgent: (
id) =>void
Defined in: src/waldiez/models/Stores/IAgentStore.ts:58
Delete a specific agent from the store.
Parameters¶
id¶
string
Returns¶
void
exportAgent()¶
exportAgent: (
agentId,hideSecrets) =>object
Defined in: src/waldiez/models/Stores/IAgentStore.ts:82
Export a specific agent from the store.
Parameters¶
agentId¶
string
hideSecrets¶
boolean
Returns¶
object
The exported agent data.
getAgentById()¶
getAgentById: (
id) =>WaldiezNodeAgent|null
Defined in: src/waldiez/models/Stores/IAgentStore.ts:27
Get a specific agent by its ID.
Parameters¶
id¶
string
Returns¶
WaldiezNodeAgent | null
The agent with the specified ID, or null if not found.
See¶
getAgentConnections()¶
getAgentConnections: (
nodeId,options?) =>WaldiezAgentConnections
Defined in: src/waldiez/models/Stores/IAgentStore.ts:89
Get the connections of a specific agent.
Parameters¶
nodeId¶
string
options?¶
sourcesOnly?¶
boolean
targetsOnly?¶
boolean
Returns¶
An object containing sources and targets with their respective nodes and edges.
getAgents()¶
getAgents: () =>
WaldiezNodeAgent[]
Defined in: src/waldiez/models/Stores/IAgentStore.ts:20
Get the stored agents.
Returns¶
An array of agents.
See¶
getGroupManager()¶
getGroupManager: () =>
WaldiezNodeAgent|undefined
Defined in: src/waldiez/models/Stores/IAgentStore.ts:129
Get the first available group manager agent node
Returns¶
WaldiezNodeAgent | undefined
The first group manager found if any
See¶
getGroupMembers()¶
getGroupMembers: (
groupId) =>WaldiezNodeAgent[]
Defined in: src/waldiez/models/Stores/IAgentStore.ts:102
Get the members of a specific group.
Parameters¶
groupId¶
string
Returns¶
An array of agents in the group.
See¶
importAgent()¶
importAgent: (
agent,agentId,skipLinks,position,save) =>WaldiezNodeAgent
Defined in: src/waldiez/models/Stores/IAgentStore.ts:69
Import an agent into the store.
Parameters¶
agent¶
agentId¶
string
skipLinks¶
boolean
position¶
{ x: number; y: number; } | undefined
save¶
boolean
Returns¶
The imported agent.
See¶
removeGroupMember()¶
removeGroupMember: (
groupId,memberId) =>void
Defined in: src/waldiez/models/Stores/IAgentStore.ts:115
Remove a member from a specific group.
Parameters¶
groupId¶
string
memberId¶
string
Returns¶
void
setAgentGroup()¶
setAgentGroup: (
agentId,groupId,position?) =>void
Defined in: src/waldiez/models/Stores/IAgentStore.ts:122
Set the group of a specific agent.
Parameters¶
agentId¶
string
groupId¶
string
position?¶
XYPosition
Returns¶
void
updateAgentData()¶
updateAgentData: (
id,data) =>void
Defined in: src/waldiez/models/Stores/IAgentStore.ts:53
Update the data of a specific agent.
Parameters¶
id¶
string
data¶
Partial\<WaldiezNodeAgentData>
Returns¶
void