Namespace SuperOffice.CRM.Documents

Classes

ArchiveTempFileProvider

This class implements the ITempFileProvider interface and makes available temp file services. It uses the Document section in the config file to determine impersonation options and file path.

AsponseInitializer

CheckoutData

The data container for serializing the checkout meta-data.

CheckoutInfo

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

CommandInfo

An instance of this class describes a custom command, declared and implemented by a document plugin

Constants

String constants for capability and property names

Constants.Capabilities

String constants for document plugin capability names

Constants.GUI

String constants related to custom Graphical User Interface

Constants.GUI.Names

String constants for predefined GUI names that will be requested from a document plugin

Constants.Properties

String constants for document-dependent property names

Constants.Values

String constants for capability and property values, where fixed values are used

DocumentBase

Base class for document handling.

DocumentPlugin2Attribute

Attribute for document plugins, implementing the IDocumentPlugin2 interface

DocumentTemplateInfo

Information about the document template. Passed to plugins to avoid coupling them directly to database schema.

HtmlToPdf

PhysicalDocument

Facade for the Document Plugin system, and one-stop-shop for physical-document operations

PhysicalDocumentTemplate

Wraps the stream access to the document template contents. Primarily for access to Mail Templates. See also PhysicalDocument

SoArc2

Document plugin for SuperOffice standard document archive (i.e SO_ARC) with Check-in/Check-out & versioning features.

SoArc2CheckoutHelper

Class for helping with locking/checkout functionality

SoArc2Helper

Helper class containing utility methods (e.g to retrieve data from ForeignKey Table)

TempFileProviderAttribute

Attribute identifying a class as a provider of temp file services. The class must also implement the ITempFileProvider interface.

TemplateInfo

Information about a document template, i.e., a document that generally contains unresolved merge tags and that is used as the source for creating new documents. Used by plugins to describe templates to NetServer without using database records.

VersionInfo

An instance of this class represents information about one version of one document

Interfaces

ICheckinFileOperations

Only public so we can access this during tests.

IDocumentPlugin2

This is the API that needs to be implemented by document plugins - objects that provide the link between a document repository and SuperOffice NetServer

IDocumentPluginOptional

Optional interface for a document plugin if it needs to determine at runtime (during factory initialization) if it is available/optional.
Typical checks could be to see if required configuration, licese of feature toggle.

IDocumentPluginTravel

Optional interface that Document Plugins can choose to implement. It is called when starting and stopping an offline (Travel) session, and is generally used to copy centrally-stored documents to local storage and back again.

ITempFileProvider

Interface defining a plugin that offers services for reading and writing temporary files.

Enums

CheckoutState

Enum listing the possible checkout states of a document, as seen from outside the document plugin

DocumentLockSemantics

Locking semantics requested/applied to a document