OpenPRA Documentation

backends-web-backend

Class: PosDocumentsService ​

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:47

Implements ​

  • OnModuleInit

Constructors ​

Constructor ​

new PosDocumentsService(posWorkbookModel, posDocModel, projectsService, rolesService): PosDocumentsService

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:52

Parameters ​

posWorkbookModel ​

Model<PosWorkbookDocument>

posDocModel ​

Model<PosWorkbookDocumentDocument>

projectsService ​

ProjectsService

rolesService ​

WorkbookRolesService

Returns ​

PosDocumentsService

Methods ​

list() ​

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

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:100

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<PosDocumentEntry[]>

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:59

Returns ​

void

Implementation of ​

OnModuleInit.onModuleInit

presignedDownload() ​

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

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:180

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/pos-workbooks/pos-documents.service.ts:167

Parameters ​

workbookId ​

string

documentId ​

string

acting ​

ActingUser

Returns ​

Promise<void>

removeAllForWorkbook() ​

removeAllForWorkbook(workbookId): Promise<void>

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:188

Parameters ​

workbookId ​

string

Returns ​

Promise<void>

update() ​

update(workbookId, documentId, fields, acting): Promise<PosDocumentEntry>

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:144

Parameters ​

workbookId ​

string

documentId ​

string

fields ​
name? ​

string

notes? ​

string

acting ​

ActingUser

Returns ​

Promise<PosDocumentEntry>

upload() ​

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

Defined in: backends/web-backend/src/pos-workbooks/pos-documents.service.ts:114

Parameters ​

workbookId ​

string

input ​

UploadInput

acting ​

ActingUser

Returns ​

Promise<PosDocumentEntry>