Skip to main content

ProjectMembers

Workspace API

Workspace API / models/ProjectMembers

models/ProjectMembers

Functions​

addMemberToProject()​

addMemberToProject(data, client?): Promise<ProjectMember>

Defined in: models/ProjectMembers.ts:12

Add member to project

Parameters​

data​

AddProjectMemberData

client?​

any

Returns​

Promise<ProjectMember>

removeMemberFromProject()​

removeMemberFromProject(projectId, userId, client?): Promise<boolean>

Defined in: models/ProjectMembers.ts:57

Remove member from project

Parameters​

projectId​

string

userId​

string

client?​

any

Returns​

Promise<boolean>

updateMemberRole()​

updateMemberRole(projectId, userId, newRoleId, client?): Promise<ProjectMember | null>

Defined in: models/ProjectMembers.ts:78

Update member role in project

Parameters​

projectId​

string

userId​

string

newRoleId​

string

client?​

any

Returns​

Promise<ProjectMember | null>

getProjectMembers()​

getProjectMembers(projectId): Promise<ProjectMemberWithDetails[]>

Defined in: models/ProjectMembers.ts:106

Get project members with details

Parameters​

projectId​

string

Returns​

Promise<ProjectMemberWithDetails[]>

getUserProjectRole()​

getUserProjectRole(projectId, userId): Promise<{ role_name: string; role_description: string; } | null>

Defined in: models/ProjectMembers.ts:138

Get user's role in project Returns the user's role if they have an explicit assignment, or 'admin' if they created the project

Parameters​

projectId​

string

userId​

string

Returns​

Promise<{ role_name: string; role_description: string; } | null>

userHasProjectAccess()​

userHasProjectAccess(projectId, userId): Promise<boolean>

Defined in: models/ProjectMembers.ts:172

Check if user has access to project

Parameters​

projectId​

string

userId​

string

Returns​

Promise<boolean>

userHasProjectPermission()​

userHasProjectPermission(projectId, userId, permission): Promise<boolean>

Defined in: models/ProjectMembers.ts:198

Check if user has specific permission in project

Parameters​

projectId​

string

userId​

string

permission​

"read" | "write" | "admin"

Returns​

Promise<boolean>

getProjectMembersWithFilters()​

getProjectMembersWithFilters(filters): Promise<{ members: ProjectMemberWithDetails[]; total: number; }>

Defined in: models/ProjectMembers.ts:237

Get project members with filters

Parameters​

filters​

ProjectMemberFilters = {}

Returns​

Promise<{ members: ProjectMemberWithDetails[]; total: number; }>

getAvailableUsersForProject()​

getAvailableUsersForProject(projectId, organizationId): Promise<object[]>

Defined in: models/ProjectMembers.ts:306

Get available users for project (users in organization but not in project)

Parameters​

projectId​

string

organizationId​

string

Returns​

Promise<object[]>

getProjectRoles()​

getProjectRoles(): Promise<object[]>

Defined in: models/ProjectMembers.ts:331

Get project roles

Returns​

Promise<object[]>