Skip to main content

service/domain/document/workflowitem_document_delete

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

Table of contents

Functions

Functions

deleteDocument

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

Deletes a document.

Parameters

NameTypeDescription
ctxCtxThe context.
userServiceUserThe user performing the action.
projectIdstringThe ID of the project.
subprojectIdstringThe ID of the subproject.
workflowitemIdstringThe ID of the workflowitem.
documentIdstringThe ID of the document to delete.
repositoryDeleteDocumentRepositoryThe 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(obj): obj is ExternalLinkReference

Parameters

NameType
objDocumentOrExternalLinkReference | UploadedDocument

Returns

obj is ExternalLinkReference

Defined in

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