Interface IDocumentRepositoryInstance

Namespace

JobFlow.Core.Documents

Assembly

JobFlow.Core.dll

Operations for documents.

public interface IDocumentRepositoryInstance

Extension Methods

JsonExtentions.ToJsonBytes<T>(T)

JsonExtentions.ToJsonElement<T>(T)

JsonExtentions.ToJsonString<T>(T)

AutoMapperExtensions.Map<T>(T, IMapper)

Remarks

This class allows one to manage documents, including both the workitem data as well as attachments. Note that attachments beyond the primary workitem data document cannot be used to match items in the routing rules.

This service cannot be resolved directly. Use IDocumentRepository to retrieve an appropriate IDocumentRepositoryInstance instance.

JobFlow.Data.Entities.IAttachmentCollection designates any entity that can accept attachments.

Methods

CreateAsync(IDocument)

Create an attachment.

Task<Guid> CreateAsync(IDocument data)

Parameters

data IDocument

Returns

Task<Guid>

DeleteAsync(IEnumerable<Guid>)

Delete the list of documents and attachments.

Task DeleteAsync(IEnumerable<Guid> attachmentIds)

Parameters

attachmentIds IEnumerable<Guid>

Returns

Task

DeleteAsync(Guid)

Delete the document and attachment.

Task DeleteAsync(Guid attachmentId)

Parameters

attachmentId Guid

Returns

Task

RetrieveAsync(Guid, string)

Retrieve the attachment document.

Task<IDocument> RetrieveAsync(Guid attachmentId, string typeName)

Parameters

attachmentId Guid

typeName string

Returns

Task<IDocument>

RetrieveAsync<T>(Guid)

Retrieve the attachment document.

Task<Document<T>> RetrieveAsync<T>(Guid attachmentId)

Parameters

attachmentId Guid

Returns

Task<Document<T>>

Type Parameters

T

UpdateAsync<T>(Guid, Document<T>, Action<Document<T>>)

Update an existing attachment document.

Task<Document<T>> UpdateAsync<T>(Guid attachmentId, Document<T> initial, Action<Document<T>> updateAction)

Parameters

attachmentId Guid

initial Document<T>

updateAction Action<Document<T>>

Returns

Task<Document<T>>

Type Parameters

T