OpenPRA Documentation

backends-web-backend

Class: ScDocumentsService ​

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:46

Implements ​

  • OnModuleInit

Constructors ​

Constructor ​

new ScDocumentsService(scWorkbookModel, scDocModel, projectsService, rolesService): ScDocumentsService

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:51

Parameters ​

scWorkbookModel ​

Model<ScWorkbookDocument>

scDocModel ​

Model<ScWorkbookDocumentDocument>

projectsService ​

ProjectsService

rolesService ​

WorkbookRolesService

Returns ​

ScDocumentsService

Methods ​

list() ​

list(workbookId, acting): Promise<ScDocumentEntry[]>

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:99

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<ScDocumentEntry[]>

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:58

Returns ​

void

Implementation of ​

OnModuleInit.onModuleInit

presignedDownload() ​

presignedDownload(workbookId, documentId, acting): Promise<{ filename: string; url: string; }>

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:154

Parameters ​

workbookId ​

string

documentId ​

string

acting ​

ActingUser

Returns ​

Promise<{ filename: string; url: string; }>

remove() ​

remove(workbookId, documentId, acting): Promise<void>

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:141

Parameters ​

workbookId ​

string

documentId ​

string

acting ​

ActingUser

Returns ​

Promise<void>

removeAllForWorkbook() ​

removeAllForWorkbook(workbookId): Promise<void>

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:162

Parameters ​

workbookId ​

string

Returns ​

Promise<void>

upload() ​

upload(workbookId, input, acting): Promise<ScDocumentEntry>

Defined in: backends/web-backend/src/sc-workbooks/sc-documents.service.ts:112

Parameters ​

workbookId ​

string

input ​

UploadInput

acting ​

ActingUser

Returns ​

Promise<ScDocumentEntry>