OpenPRA Documentation

backends-web-backend

Class: SeismicPraDocumentsService ​

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:37

Implements ​

  • OnModuleInit

Constructors ​

Constructor ​

new SeismicPraDocumentsService(workbookModel, documentModel, projectsService, rolesService): SeismicPraDocumentsService

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:42

Parameters ​

workbookModel ​

Model<SeismicPraWorkbookDocument>

documentModel ​

Model<SeismicPraWorkbookDocumentDocument>

projectsService ​

ProjectsService

rolesService ​

WorkbookRolesService

Returns ​

SeismicPraDocumentsService

Methods ​

list() ​

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

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:84

Parameters ​

workbookId ​

string

acting ​

ActingUser

Returns ​

Promise<SeismicPraDocumentEntry[]>

onModuleInit() ​

onModuleInit(): void

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:49

Returns ​

void

Implementation of ​

OnModuleInit.onModuleInit

presignedDownload() ​

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

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:138

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/seismic-pra-workbooks/seismic-pra-documents.service.ts:129

Parameters ​

workbookId ​

string

documentId ​

string

acting ​

ActingUser

Returns ​

Promise<void>

removeAllForWorkbook() ​

removeAllForWorkbook(workbookId): Promise<void>

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:145

Parameters ​

workbookId ​

string

Returns ​

Promise<void>

update() ​

update(workbookId, documentId, requestedName, acting): Promise<SeismicPraDocumentEntry>

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:110

Parameters ​

workbookId ​

string

documentId ​

string

requestedName ​

string | undefined

acting ​

ActingUser

Returns ​

Promise<SeismicPraDocumentEntry>

upload() ​

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

Defined in: backends/web-backend/src/seismic-pra-workbooks/seismic-pra-documents.service.ts:97

Parameters ​

workbookId ​

string

input ​

UploadInput

acting ​

ActingUser

Returns ​

Promise<SeismicPraDocumentEntry>