Table of Contents

Interface IDocument

Namespace
The.Documents
Assembly
Instagile.dll

Business-logic level document handle; equivalent of an IValue<T> for document attributes.

public interface IDocument

Properties

Access 

DocumentAccessAssertion Access { get; }

Property Value

DocumentAccessAssertion

ID 

Guid ID { get; }

Property Value

Guid

Methods

DownloadAsync(CancellationToken) 

Task<Stream> DownloadAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<Stream>

DownloadAsync(IPrincipal?, CancellationToken?) 

Task<Stream> DownloadAsync(IPrincipal? principal = null, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal
cancellationToken CancellationToken?

Returns

Task<Stream>

DownloadBufferAsync(CancellationToken) 

Task<byte[]> DownloadBufferAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<byte[]>

DownloadBufferAsync(IPrincipal?, CancellationToken?) 

Task<byte[]> DownloadBufferAsync(IPrincipal? principal = null, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal
cancellationToken CancellationToken?

Returns

Task<byte[]>

DownloadFileAsync(string, CancellationToken) 

Task DownloadFileAsync(string localFilename, CancellationToken cancellationToken)

Parameters

localFilename string
cancellationToken CancellationToken

Returns

Task

DownloadFileAsync(string, IPrincipal?, CancellationToken?) 

Task DownloadFileAsync(string localFilename, IPrincipal? principal = null, CancellationToken? cancellationToken = null)

Parameters

localFilename string
principal IPrincipal
cancellationToken CancellationToken?

Returns

Task

GetMetadataAsync(CancellationToken) 

Task<FileMetadata> GetMetadataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<FileMetadata>

GetMetadataAsync(IPrincipal?, CancellationToken?) 

Task<FileMetadata> GetMetadataAsync(IPrincipal? principal = null, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal
cancellationToken CancellationToken?

Returns

Task<FileMetadata>