service/domain/document/workflowitem_document_delete

Api Code Documentation / Exports / service/domain/document/workflowitem_document_delete

Table of contents

Functions

• deleteDocument
• isDocumentLink

Functions

deleteDocument

▸ deleteDocument(ctx, user, projectId, subprojectId, workflowitemId, documentId, repository): Promise<Type<{ newEvents: BusinessEvent[] }>>

Deletes a document.

Parameters

Name	Type	Description
ctx	Ctx	The context.
user	ServiceUser	The user performing the action.
projectId	string	The ID of the project.
subprojectId	string	The ID of the subproject.
workflowitemId	string	The ID of the workflowitem.
documentId	string	The ID of the document to delete.
repository	DeleteDocumentRepository	The repository for deleting the document.

Returns

Promise<Type<{ newEvents: BusinessEvent[] }>>

A promise that resolves to an object containing the new events.

Defined in

src/service/domain/document/workflowitem_document_delete.ts:137

---

isDocumentLink

▸ isDocumentLink(obj): obj is ExternalLinkReference

Parameters

Name	Type
obj	DocumentOrExternalLinkReference | UploadedDocument

Returns

obj is ExternalLinkReference

Defined in

src/service/domain/document/workflowitem_document_delete.ts:24