UseProjectsResult
Defined in: src/react/useProjects.ts:45
Result returned by useProjects hook.
Properties
createProject()
createProject: (
opts?:CreateProjectOptions) =>Promise<StoredProject>
Defined in: src/react/useProjects.ts:60
Create a new project
Parameters
| Parameter | Type |
|---|---|
|
|
Returns
Promise<StoredProject>
currentProjectId
currentProjectId:
string|null
Defined in: src/react/useProjects.ts:50
Currently selected project ID
deleteProject()
deleteProject: (
projectId:string) =>Promise<boolean>
Defined in: src/react/useProjects.ts:73
Delete a project (soft delete)
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
Promise<boolean>
getConversationsByProject()
getConversationsByProject: (
projectId:string|null) =>Promise<StoredConversation[]>
Defined in: src/react/useProjects.ts:86
Get conversations by project (null = no project)
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
Promise<StoredConversation[]>
getProject()
getProject: (
projectId:string) =>Promise<StoredProject|null>
Defined in: src/react/useProjects.ts:62
Get a single project by ID
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
Promise<StoredProject | null>
getProjectConversationCount()
getProjectConversationCount: (
projectId:string) =>Promise<number>
Defined in: src/react/useProjects.ts:79
Get count of conversations in a project
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
Promise<number>
getProjectConversations()
getProjectConversations: (
projectId:string) =>Promise<StoredConversation[]>
Defined in: src/react/useProjects.ts:77
Get all conversations in a project
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
Promise<StoredConversation[]>
getProjects()
getProjects: () =>
Promise<StoredProject[]>
Defined in: src/react/useProjects.ts:64
Get all projects
Returns
Promise<StoredProject[]>
inboxProjectId
inboxProjectId:
string|null
Defined in: src/react/useProjects.ts:94
The ID of the default Inbox project (auto-created)
isLoading
isLoading:
boolean
Defined in: src/react/useProjects.ts:54
Whether projects are being loaded
isReady
isReady:
boolean
Defined in: src/react/useProjects.ts:56
Whether the projects system is ready (database table exists)
projects
projects:
StoredProject[]
Defined in: src/react/useProjects.ts:48
List of all projects
refreshProjects()
refreshProjects: () =>
Promise<void>
Defined in: src/react/useProjects.ts:92
Refresh the projects list from database
Returns
Promise<void>
setCurrentProjectId()
setCurrentProjectId: (
id:string|null) =>void
Defined in: src/react/useProjects.ts:52
Set the current project ID
Parameters
| Parameter | Type |
|---|---|
|
|
|
Returns
void
updateConversationProject()
updateConversationProject: (
conversationId:string,projectId:string|null) =>Promise<boolean>
Defined in: src/react/useProjects.ts:81
Move a conversation to a project (or remove with null)
Parameters
| Parameter | Type |
|---|---|
|
|
|
|
|
|
Returns
Promise<boolean>
updateProject()
updateProject: (
projectId:string,opts:UpdateProjectOptions) =>Promise<boolean>
Defined in: src/react/useProjects.ts:68
Update a project with partial options
Parameters
| Parameter | Type |
|---|---|
|
|
|
|
|
Returns
Promise<boolean>
updateProjectName()
updateProjectName: (
projectId:string,name:string) =>Promise<boolean>
Defined in: src/react/useProjects.ts:66
Update a project’s name
Parameters
| Parameter | Type |
|---|---|
|
|
|
|
|
|
Returns
Promise<boolean>