OpenPRA Documentation

backends-web-backend

Class: WorkbookRolesService ​

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:69

Constructors ​

Constructor ​

new WorkbookRolesService(workbookModel, roleModel, userModel, teamModel, projectsService): WorkbookRolesService

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:70

Parameters ​

workbookModel ​

Model<WorkbookDocument>

roleModel ​

Model<WorkbookRoleDocument>

userModel ​

Model<Document<unknown, { }, User, { }, { }> & User & object & object>

teamModel ​

Model<Document<unknown, { }, Team, { }, { }> & Team & object & object>

projectsService ​

ProjectsService

Returns ​

WorkbookRolesService

Methods ​

assignedUsernamesFor() ​

assignedUsernamesFor(workbookId, role): Promise<string[]>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:116

Parameters ​

workbookId ​

string

role ​

WorkbookRoleName

Returns ​

Promise<string[]>

assignTeam() ​

assignTeam(workbookId, teamId, role, acting): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:323

Parameters ​

workbookId ​

string

teamId ​

string

role ​

WorkbookRoleName

acting ​

ActingUser

Returns ​

Promise<WorkbookRolesResponse>

assignUser() ​

assignUser(workbookId, username, role, acting, designation?): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:293

Parameters ​

workbookId ​

string

username ​

string

role ​

WorkbookRoleName

acting ​

ActingUser

designation? ​

string

Returns ​

Promise<WorkbookRolesResponse>

createInitialPreparer() ​

createInitialPreparer(workbookId, ownerUsername): Promise<void>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:193

Parameters ​

workbookId ​

string

ownerUsername ​

string

Returns ​

Promise<void>

enrichedRoleHolders() ​

enrichedRoleHolders(workbookId): Promise<WorkbookRoleHolderInfo[]>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:131

Parameters ​

workbookId ​

string

Returns ​

Promise<WorkbookRoleHolderInfo[]>

list() ​

list(workbookId, acting): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:197

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<WorkbookRolesResponse>

myTeamIds() ​

myTeamIds(username): Promise<string[]>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:90

Parameters ​

username ​

string

Returns ​

Promise<string[]>

resolveEffectiveRoles() ​

resolveEffectiveRoles(workbookId, username): Promise<WorkbookRoleName[]>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:98

Parameters ​

workbookId ​

string

username ​

string

Returns ​

Promise<WorkbookRoleName[]>

unassignTeam() ​

unassignTeam(workbookId, teamId, role, acting): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:354

Parameters ​

workbookId ​

string

teamId ​

string

role ​

WorkbookRoleName

acting ​

ActingUser

Returns ​

Promise<WorkbookRolesResponse>

unassignUser() ​

unassignUser(workbookId, username, role, acting): Promise<WorkbookRolesResponse>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:342

Parameters ​

workbookId ​

string

username ​

string

role ​

WorkbookRoleName

acting ​

ActingUser

Returns ​

Promise<WorkbookRolesResponse>

workbookIdsAssignedTo() ​

workbookIdsAssignedTo(username): Promise<Map<string, WorkbookRoleName[]>>

Defined in: backends/web-backend/src/workbooks/workbook-roles.service.ts:177

Parameters ​

username ​

string

Returns ​

Promise<Map<string, WorkbookRoleName[]>>