The Relativity.Imaging.Services.Interfaces namespace provides functionality for Creating, Updating and Reading Imaging Profiles, Imaging Sets, and Application Field Codes, and provides read functionality for Native Types.
Classes
| Class | Description | |
|---|---|---|
 | ApplicationFieldCode |
Contains information regarding how to handle certain application fields in Imaging Sets.
|
| ApplicationFieldCodeRef |
Serves as the base class for ApplicationFieldCode instances.
|
| BasicImagingEngineOptions |
Specifies the basic imaging engine options for an ImagingProfile instance.
|
| EmailOptions |
Indicates the native imaging options set on an ImagingProfile instance used when imaging email messages.
|
| HtmlOptions |
Indicates the native imaging options set on an ImagingProfile instance used when imaging HTML content.
|
| ImageDocumentJob |
ImageDocumentJob - This is used by image on the fly. It should not be used for mass imaging.
It allows one document to use an alternate native (ie... for PDF image upload)
|
| ImageDocumentResponse |
Represents the current status of a running Imaging Job for an ImageDocument request (single document imaging jobs).
|
| ImagingJob |
Represents a job request sent to the imaging engine to generated a set of documents identified by a specific ImagingSet instance.
|
| ImagingJobBase |
Base class for Imaging Jobs.
|
| ImagingProfile |
Represents the settings used to image a group of documents.
|
| ImagingProfileRef |
Represents a base class for an ImagingProfile object, and contains properties referenced by it.
|
| ImagingSet |
Represents an imaging set, which consists of an ImagingProfile and a saved search containing documents for imaging.
|
| ImagingSetJobStatus |
Represents the current status of a running Imaging Job for an ImagingSet.
|
| ImagingSetRef |
Represents a base class for an ImagingSet object, and contains properties referenced by it.
|
| ImagingSetStatus |
Represents the current state of an imaging job for an ImagingSet.
|
| NativeImagingEngineOptions |
Represents the options set on an ImagingProfile for use with native imaging jobs.
|
| NativeType |
Represents document types in the Imaging API.
|
| NativeTypeRef |
Represents a base class for a NativeType object, and contains properties referenced by it.
|
| PresentationOptions |
Represents the settings for displaying speaker notes and page orientation for presentation slides, such as Microsoft PowerPoint.
|
| SpreadsheetOptions |
Represents the spreadsheet options set on an ImagingProfile instance.
|
| StopImagingJobRequest |
Represents a job request sent to the imaging engine to cancel an in-progress imaging job.
|
| StopImagingJobResponse |
Represents a response from the imaging engine that indicates whether an imaging job was successfully canceled.
|
| UpdateJobPriorityRequest |
The request object for updating the priority of an imaging job.
|
| UpdateJobPriorityResponse |
The response object for updating the priority of an imaging job.
|
| WordProcessingOptions |
Represents the word processing options set on an ImagingProfile instance.
|
Interfaces
| Interface | Description | |
|---|---|---|
 | IApplicationFieldCodeManager |
Exposes methods on the Application Field Code Manager service used for creating, updating, reading, and deleting ApplicationFieldCode instances.
|
| IImagingJobManager |
Exposes methods on the Imaging Job Manager service used for running, stopping, and retrying ImagingSet jobs.
|
| IImagingModule |
Provides a module interface declaration for all Relativity imaging services.
|
| IImagingProfileManager |
Exposes methods for creating, updating, reading, and deleting ImagingProfile instances.
|
| IImagingSetManager |
Exposes methods for creating, updating, reading, and deleting ImagingSet instances.
|
| INativeTypeManager |
Exposes a method for retrieving NativeType instances by their ArtifactID.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | ApplicationFieldCodeOption |
Specifies how an application field code is handled during a ImagingJob.
|
| ApplicationType |
ApplicationType specifies the source desktop application for a FieldCode mapping
|
| BasicCategory |
Defines the choices for the BasicCategory property on NativeType class.
|
| DitheringAlgorithm |
Specifies the dithering algorithm used for an ImagingProfile instance.
|
| Formatting |
Specifies spreadsheet formatting as a multiple choice option on the SpreadsheetOptions instance.
|
| ImageFormat |
Specifies the image format for images generated from a specific ImagingProfile instance.
|
| ImageSize |
Specifies the size of images generated from a specific ImagingProfile instance.
|
| ImagingMethod |
Specifies the basic or native imaging option defined on an ImagingProfile instance.
|
| Include |
Specifies document attributes added by word processing software to include in the imaging output.
|
| IncludeGridlines |
Renders the original gridline settings in the imaging output for spreadsheets.
|
| IncludeHeadersAndFooters |
Specifies whether to render headers and footers in spreadsheets.
|
| IncludeRowAndColumnHeadings |
Specifies whether to render row and column headings in the imaging output of spreadsheets.
|
| NativeCategory |
Specifies a grouping of related file types or formats for native imaging.
|
| Orientation |
Specifies the page orientation for images generated from an ImagingProfile instance.
|
| PageOrder |
Specifies the order used to render the pages in spreadsheets.
|
| PageOrientation |
option for orientation of a given page used by ImagingProfile's WordProcessingOptions |
| PaperSizeOrientation |
Specifies the paper size and orientation used to render the pages in a spreadsheet.
|
| PrintArea |
Specifies a print area in a spreadsheet used for an imaging job.
|
| SlideOrientation |
Specifies the orientation of presentation slides, such as Microsoft PowerPoint.
|
| TextVisibility |
Specifies the visibility of the text in a spreadsheet by controlling background and font color.
|