The HotDocs.Sdk.Server.Contracts namespace contains shared data types
and some protocols/algorithms necessary for proper communication between client code
and HotDocs-provided web services. This includes e.g. WCF contracts for data types
and services, and the standard HMAC algorithm necessary to call Cloud Services.
Classes
| Class | Description | |
|---|---|---|
|
|
AssemblyResult |
This class is used to return the results from assembling a document.
|
|
|
BasicOutputOptions |
encapsulates all OutputOptions classes that incorporate support for document-level metadata
|
|
|
BinaryObject |
This class is used for sending and receiving files, such as answers, templates, and documents.
|
|
|
ComponentInfo |
This class provides information about components in a template's interview.
|
|
|
DialogInfo |
This class provides details about a dialog. In the XML, the name of this class is "Dlg".
|
|
|
DialogItemInfo |
This class provides information about items in a dialog.
|
|
|
HMAC |
This class is used for security verification when sending requests to HotDocs Core Services.
HMAC stands for Hash-based Message Authentication Code.
|
|
|
HMACException |
This is the exception that is raised when HMAC values do not match between the client and server.
|
|
|
HtmlOutputOptions |
Output options for HTML/MHTML documents
|
|
|
OutputOptions |
Abstract base class of all OutputOptions.
Provides facilities for serializing options in a very compact string representation for optimal transmission.
|
|
|
PdfOutputOptions |
Output options for PDF documents.
|
|
|
PendingAssembly |
This class represents an assembly that should be run, usually as a result of assembling a related template.
|
|
|
TemplateInfo |
This class provides details about a template.
|
|
|
TextOutputOptions |
Output options for plain text documents
|
|
|
VariableInfo |
This class provides details about a variable. In the XML, the name of this class is "Var".
|
Interfaces
| Interface | Description | |
|---|---|---|
|
|
ICore |
The Core service contract
|
|
|
IHDSvc |
The following web methods are available in the basic HotDocs Server web service:
|
Enumerations
| Enumeration | Description | |
|---|---|---|
|
|
AssemblyOptions |
This enumeration contains options for how the document is assembled.
|
|
|
HDSupportFilesBuildFlags |
This enumeration contains options for what server files are built.
|
|
|
InterviewFormat |
The InterviewFormat enumeration is used when referring to the types of browser-based interviews supported by HotDocs Server.
|
|
|
InterviewOptions |
This enumeration lists the options available when requesting an interview.
|
|
|
OutputFormat |
This enumeration lists the types of files that can be returned by a call to AssembleDocument.
|
|
|
PdfPermissions |
PdfPermissions
|