Interface IDocumentStore

Namespace

The.Documents

Assembly

Instagile.dll

Implemented by plugins to provide document storage and retrieval.

public interface IDocumentStore

Methods

AddAccessRules(CallbackEnvironment, IServices, params IReadOnlyList<NewAccessRule>)

Task AddAccessRules(CallbackEnvironment environment, IServices services, params IReadOnlyList<NewAccessRule> newRules)

Parameters

environment CallbackEnvironment

services IServices

newRules IReadOnlyList<NewAccessRule>

Returns

Task

GetDocumentData(CallbackEnvironment, IServices, Guid, DocumentAccessAssertion)

Task<Stream?> GetDocumentData(CallbackEnvironment environment, IServices services, Guid id, DocumentAccessAssertion access)

Parameters

environment CallbackEnvironment

services IServices

id Guid

access DocumentAccessAssertion

Returns

Task<Stream>

GetFileMetadata(CallbackEnvironment, IServices, Guid, DocumentAccessAssertion)

Task<FileMetadata?> GetFileMetadata(CallbackEnvironment environment, IServices services, Guid id, DocumentAccessAssertion access)

Parameters

environment CallbackEnvironment

services IServices

id Guid

access DocumentAccessAssertion

Returns

Task<FileMetadata>

GetImageMetadata(CallbackEnvironment, IServices, Guid, DocumentAccessAssertion)

Task<ImageMetadata?> GetImageMetadata(CallbackEnvironment environment, IServices services, Guid id, DocumentAccessAssertion access)

Parameters

environment CallbackEnvironment

services IServices

id Guid

access DocumentAccessAssertion

Returns

Task<ImageMetadata>

PutFile(CallbackEnvironment, IServices, Stream, string, string, DocumentAccessRule, IProgress<long>?)

Task<Guid> PutFile(CallbackEnvironment environment, IServices services, Stream data, string originalFilename, string mimeType, DocumentAccessRule rule, IProgress<long>? progress = null)

Parameters

environment CallbackEnvironment

services IServices

data Stream

originalFilename string

mimeType string

rule DocumentAccessRule

progress IProgress<long>

Returns

Task<Guid>

PutImage(CallbackEnvironment, IServices, Stream, string, string, int, int, Guid?, DocumentAccessAssertion?, DocumentAccessRule, IProgress<long>?)

Task<Guid> PutImage(CallbackEnvironment environment, IServices services, Stream data, string originalFilename, string mimeType, int width, int height, Guid? thumbnailFor, DocumentAccessAssertion? thumbnailAccess, DocumentAccessRule rule, IProgress<long>? progress = null)

Parameters

environment CallbackEnvironment

services IServices

data Stream

originalFilename string

mimeType string

width int

height int

thumbnailFor Guid?

thumbnailAccess DocumentAccessAssertion

rule DocumentAccessRule

progress IProgress<long>

Returns

Task<Guid>