The RestClient type exposes the following members.
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
| RestClient |
Constructs a Client object.
|
Methods
| Name | Description | |
|---|---|---|
| AssembleDocument |
Assembles a document from the specified template and answersets.
(Inherited from ClientBase.) | |
| CreateSession |
Creates a new session for assembling documents using the HotDocs Cloud Services Rest API.
| |
| DeleteTheme |
Deletes a theme file.
| |
| Dispose | Releases all resources used by the RestClient | |
| (Inherited from | ||
| GetAnswers |
Combines the provided answersets to form an aggregate answerset.
(Inherited from ClientBase.) | |
| GetComponentInfo |
Gets component information for the specified template.
(Inherited from ClientBase.) | |
Serves as a hash function for a particular type. (Inherited from | ||
| GetInterview |
Gets an interview for the specified template.
(Inherited from ClientBase.) | |
| GetSessionDoc |
Saves the specified session file to a locaiton on the local disk.
| |
| GetSessionDocList |
Returns an array of assembled documents associated with the session.
| |
| GetSessionState |
Returns the session state.
| |
| GetThemeFile(String, String) |
Returns the specified theme file as a stream.
| |
| GetThemeFile(String, String, String) |
Stores the specified theme file in the indicated file path.
| |
| GetThemeList(String) |
Returns a list of all themes that belong to the current subscriber.
| |
| GetThemeList(String, String) |
Returns a list of themes that belong to the current subscriber
and have the specified prefix.
| |
Gets the (Inherited from | ||
| PutThemeFile(String, Stream, String) |
Uploads a theme file from a stream.
| |
| PutThemeFile(String, String, String) |
Uploads a theme from from the specified file path.
| |
| RenameTheme |
Renames a theme file.
| |
| ResumeSession |
Resumes a saved session.
| |
Returns a string that represents the current object. (Inherited from | ||
| UploadPackage(String, String, Stream) |
Uploads a package to HotDocs Cloud Services from a stream.
| |
| UploadPackage(String, String, String) |
Uploads a package to HotDocs Cloud Services from the specified file path.
|
Properties
| Name | Description | |
|---|---|---|
| EndpointAddress |
Specifies an alternate address for the Cloud Services web service (e.g., https://127.0.0.1).
(Inherited from ClientBase.) | |
| OutputDir |
The name of the folder where output files will get created.
| |
| ProxyServerAddress |
Specifies the proxy server address (e.g., http://myfiddlermachine:8888).
(Inherited from ClientBase.) | |
| SigningKey |
The Subscriber's unique signing key.
(Inherited from ClientBase.) | |
| SubscriberId |
The Subscriber account identifier, found in the Administration Portal. The subscriber ID corresponds to the company or website subscribing to the service, not an individual end user.
(Inherited from ClientBase.) |
See Also