IDocumentApi Interface

Provides methods for working with documents.

Definition

Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime (in Casewhere.Runtime.dll) Version: 2.9.8.6
C#
public interface IDocumentApi

Methods

Create Create new empty document with a given file name.
Delete Delete a document.
GetMalwareScanStatus Get the malware scan status of a given document. If the antimalware feature is enabled, then return the status based on the scanning result. Otherwise, always return the Cleaned status.
IsFileExisted Check a document is existed.
OpenRead Open a document for reading.
OpenWrite Open a document for writing.
ReadAllBytes Reads the contents of the file into a byte array.
ReadToStream Reads the contents of a blob to a stream.
RequestMalwareScanning Manually make a file scan request for a specific document.
SecureShare Share document with more secured parameters
Share Share document
Obsolete
Store(DocumentInfo, Byte) Stores document with a byte array. If the document already exists, it will be overwritten.
Store(DocumentInfo, Stream) Stores document with a stream. If the document already exists, it will be overwritten.
Unshare Deactivate the token

See Also