OpenPRA Documentation

backends-web-backend

Class: MsDocumentsService ​

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

Implements ​

  • OnModuleInit

Constructors ​

Constructor ​

new MsDocumentsService(msWorkbookModel, msDocModel, projectsService, rolesService): MsDocumentsService

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

Parameters ​

msWorkbookModel ​

Model<MsWorkbookDocument>

msDocModel ​

Model<MsWorkbookDocumentDocument>

projectsService ​

ProjectsService

rolesService ​

WorkbookRolesService

Returns ​

MsDocumentsService

Methods ​

list() ​

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

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

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<MsDocumentEntry[]>

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/ms-workbooks/ms-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/ms-workbooks/ms-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/ms-workbooks/ms-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/ms-workbooks/ms-documents.service.ts:162

Parameters ​

workbookId ​

string

Returns ​

Promise<void>

upload() ​

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

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

Parameters ​

workbookId ​

string

input ​

UploadInput

acting ​

ActingUser

Returns ​

Promise<MsDocumentEntry>