ProjectsApi API

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

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

Quick Reference

Method	Description
assignThreadToGroup
checkEnvironment
checkProjectName
create
createInDefault
createTaskGroup
deleteTaskGroup
getAllWithUniqueId
getByWorkspace
getChatHistory
getConfigs
getDebugHistory
getDebugIndex
getRoot
getTaskGroups
getThreadGroup
getThreadGroupMappings
getThreads
getThreadsForGroup
getTreeBatch
getTreeChildren
getTreeItem
resetProject
runCommand
setActive
updateCodeboltYaml
updateConfig
updateProjectConfigs
updateTaskGroup

Methods

---

assignThreadToGroup

plugin.projectsApi.assignThreadToGroup(data: AssignThreadToGroupRequest): Promise<void>

Parameter	Type	Required	Description
data	AssignThreadToGroupRequest	Yes

Returns: Promise<void>

Full reference →

---

checkEnvironment

plugin.projectsApi.checkEnvironment(data: CheckEnvironmentRequest): Promise<unknown>

Parameter	Type	Required	Description
data	CheckEnvironmentRequest	Yes

Returns: Promise<unknown>

Full reference →

---

checkProjectName

plugin.projectsApi.checkProjectName(data: CheckProjectNameRequest): Promise<object>

Parameter	Type	Required	Description
data	CheckProjectNameRequest	Yes

Returns: Promise<object>

Full reference →

---

create

plugin.projectsApi.create(data: Record<string, unknown>): Promise<Project>

Parameter	Type	Required	Description
data	Record<string, unknown>	Yes

Returns: Promise<Project>

Full reference →

---

createInDefault

plugin.projectsApi.createInDefault(data: Record<string, unknown>): Promise<Project>

Parameter	Type	Required	Description
data	Record<string, unknown>	Yes

Returns: Promise<Project>

Full reference →

---

createTaskGroup

plugin.projectsApi.createTaskGroup(data: CreateTaskGroupRequest): Promise<TaskGroup>

Parameter	Type	Required	Description
data	CreateTaskGroupRequest	Yes

Returns: Promise<TaskGroup>

Full reference →

---

deleteTaskGroup

plugin.projectsApi.deleteTaskGroup(groupId: string): Promise<void>

Parameter	Type	Required	Description
groupId	string	Yes

Returns: Promise<void>

Full reference →

---

getAllWithUniqueId

plugin.projectsApi.getAllWithUniqueId(data: GetAllProjectsRequest): Promise<Project[]>

Parameter	Type	Required	Description
data	GetAllProjectsRequest	Yes

Returns: Promise<Project[]>

Full reference →

---

getByWorkspace

plugin.projectsApi.getByWorkspace(workspaceId: string): Promise<Project[]>

Parameter	Type	Required	Description
workspaceId	string	Yes

Returns: Promise<Project[]>

Full reference →

---

getChatHistory

plugin.projectsApi.getChatHistory(): Promise<unknown[]>

No parameters.

Returns: Promise<unknown[]>

Full reference →

---

getConfigs

plugin.projectsApi.getConfigs(): Promise<ProjectConfig>

No parameters.

Returns: Promise<ProjectConfig>

Full reference →

---

getDebugHistory

plugin.projectsApi.getDebugHistory(): Promise<unknown[]>

No parameters.

Returns: Promise<unknown[]>

Full reference →

---

getDebugIndex

plugin.projectsApi.getDebugIndex(): Promise<unknown>

No parameters.

Returns: Promise<unknown>

Full reference →

---

getRoot

plugin.projectsApi.getRoot(): Promise<Project>

No parameters.

Returns: Promise<Project>

Full reference →

---

getTaskGroups

plugin.projectsApi.getTaskGroups(): Promise<TaskGroup[]>

No parameters.

Returns: Promise<TaskGroup[]>

Full reference →

---

getThreadGroup

plugin.projectsApi.getThreadGroup(threadId: string): Promise<TaskGroup | null>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<TaskGroup | null>

Full reference →

---

getThreadGroupMappings

plugin.projectsApi.getThreadGroupMappings(): Promise<ThreadGroupMapping[]>

No parameters.

Returns: Promise<ThreadGroupMapping[]>

Full reference →

---

getThreads

plugin.projectsApi.getThreads(): Promise<unknown[]>

No parameters.

Returns: Promise<unknown[]>

Full reference →

---

getThreadsForGroup

plugin.projectsApi.getThreadsForGroup(groupId: string): Promise<string[]>

Parameter	Type	Required	Description
groupId	string	Yes

Returns: Promise<string[]>

Full reference →

---

getTreeBatch

plugin.projectsApi.getTreeBatch(data: BatchTreeItemsRequest): Promise<TreeItem[]>

Parameter	Type	Required	Description
data	BatchTreeItemsRequest	Yes

Returns: Promise<TreeItem[]>

Full reference →

---

getTreeChildren

plugin.projectsApi.getTreeChildren(parentId: string): Promise<TreeItem[]>

Parameter	Type	Required	Description
parentId	string	Yes

Returns: Promise<TreeItem[]>

Full reference →

---

getTreeItem

plugin.projectsApi.getTreeItem(itemId: string): Promise<TreeItem>

Parameter	Type	Required	Description
itemId	string	Yes

Returns: Promise<TreeItem>

Full reference →

---

resetProject

plugin.projectsApi.resetProject(data: ResetProjectRequest): Promise<void>

Parameter	Type	Required	Description
data	ResetProjectRequest	Yes

Returns: Promise<void>

Full reference →

---

runCommand

plugin.projectsApi.runCommand(data: RunCommandRequest): Promise<unknown>

Parameter	Type	Required	Description
data	RunCommandRequest	Yes

Returns: Promise<unknown>

Full reference →

---

setActive

plugin.projectsApi.setActive(data: SetActiveProjectRequest): Promise<void>

Parameter	Type	Required	Description
data	SetActiveProjectRequest	Yes

Returns: Promise<void>

Full reference →

---

updateCodeboltYaml

plugin.projectsApi.updateCodeboltYaml(data: UpdateCodeboltYamlRequest): Promise<void>

Parameter	Type	Required	Description
data	UpdateCodeboltYamlRequest	Yes

Returns: Promise<void>

Full reference →

---

updateConfig

plugin.projectsApi.updateConfig(data: UpdateProjectConfigRequest): Promise<void>

Parameter	Type	Required	Description
data	UpdateProjectConfigRequest	Yes

Returns: Promise<void>

Full reference →

---

updateProjectConfigs

plugin.projectsApi.updateProjectConfigs(data: UpdateProjectConfigRequest): Promise<void>

Parameter	Type	Required	Description
data	UpdateProjectConfigRequest	Yes

Returns: Promise<void>

Full reference →

---

updateTaskGroup

plugin.projectsApi.updateTaskGroup(groupId: string, data: UpdateTaskGroupRequest): Promise<TaskGroup>

Parameter	Type	Required	Description
groupId	string	Yes
data	UpdateTaskGroupRequest	Yes

Returns: Promise<TaskGroup>

Full reference →