Namespace Relativity.Testing.Framework.Models
Classes
AccountBaseInfo
Represents the base information of account.
ActionColumn
Represents a column returned as part of the results of a script action.
ActionColumnSort
Represents sorting information for query results.
ActionJob
Represents a script action job.
ActionQueryRequest
Describes conditions and sorts to be returned for a Script result query call.
ActionResultRow
Represents the values of a single row of a completed script action job.
ActionResultsQueryResponse
Represents the results that are returned as part of an ActionQueryRequest.
Agent
Represents the Relativity agent object.
AgentServer
Represents the Relativity agent server object.
AgentType
Represents the Relativity agent type object.
ApplicationFieldCode
Contains information regarding how to handle certain application fields in Imaging Sets.
Artifact
Represents the Relativity artifact object.
ArtifactIdNamePair
Represents a pair of ArtifactID and Name properties.
ArtifactReference
Represents the Relativity artifact reference object.
AutoBatchSettings
Represents values for batch set autobatching.
BaseCriteria
Represents base criteria object.
BasicImagingEngineOptions
Represents the basic options used for imaging, such as image output quality (DPI), image size, and image format.
Batch
Represents a Relativity Batch.
BatchProcessResult
Represents values That are retuurned after creating or purging batches.
BatchSet
Represents a Relativity BatchSet used to organize batches.
Category
Represents part of a category in a layout. The assocaited CategoryElement also contains information about the category itself.
CategoryCustomText
Represents a custom text on a category.
CategoryElement
Represents part of a category in a layout. The parent Category also contains information about the category itself.
CategoryField
Represents a field in the SaveFieldsAndCustomTextRequest.
Choice
Represents the Relativity choice object.
ChoiceRequest
Representation of a choiceRequest.
Client
Represents the Relativity client object.
Condition
Represents base class for Criteria Conditions.
Criteria
Singular Criteria class.
CriteriaCollection
Represents the collection of criteria conditions.
CriteriaCondition
Represents class for Criteria Condition.
CriteriaDateCondition
Represents class for date condition.
CurrencyField
Represents the Currency field object.
DateField
Represents the Date field object.
DecimalField
Represents the Decimal field object.
DefaultFieldValue<T>
Represents a default object field value.
Dependency
Represents an object dependent on another object selected for deletion.
Document
Represents the Relativity document object.
DocumentError
Contains data about the error connected to a Document.
DocumentImportOptionsBase
Options for when importing documents.
DocumentStatus
Contains data about Imaging status of a Document.
DocumentWarning
Contains data about the warning connected to a Document.
Element
Represents an Element in a CategoryElement of a category. This is normally a field, but might also be other things.
EnqueueRunJobResponse
Represents the result of enqueuing a script to be run.
Entity
Represents the Relativity entity object.
Error
Represents the Relativity error object.
Field
Represents the base field object.
FieldLayoutRelation
Represents a relation between a field and layout.
FieldPaneIcon
Represents the FieldPaneIcon.
FieldPropagate
Represents the properties to validate a field propagate request.
FileFieldDTO
Represents model for operations on File Field.
FixedLengthTextField
Represents the FixedLength field object.
Folder
Represents the Relativity Folder object.
FolderAccessStatus
Represents the Folder access status.
FolderMoveResponse
Represents the HTTP response that we get back when making a request to the MoveFolderAsync API endpoint.
FolderPermission
Represents Folder permissions.
GenericPermission
Represents the generic permission.
GenericPermissionChangeset
Represents the changeset of generic permission.
GenericPermissionsChangeset
Represents the changeset of generic permissions.
Group
Represents the Relativity group object.
GroupNames
Provides standard names of groups.
GroupPermissions
Represents the Relativity group permissions.
GroupPermissionsChangeset
Represents the changeset of group permissions.
GroupSelector
Represents the selector of enabled/disabled groups for an entity.
HeaderFooter
Represents the information on the headers and footers of produced pages.
HttpAction
An action that can be performed on the given static object.
ImageImportOptions
Options to set on Image imports.
ImagingEmailOptions
Represents the native imaging options set on an ImagingProfile instance used when imaging email messages.
ImagingHtmlOptions
Represents the native imaging options set on an ImagingProfile instance used when imaging HTML content.
ImagingJobActionResponse
Represents a response from the imaging engine that indicates whether action (stopping or updating priority) on imaging job was successful.
ImagingJobPriorityRequest
The request object for updating the priority of an imaging job.
ImagingJobRequest
Represents the Imaging Job Request.
ImagingMassJobRequest
Represents the Mass Imaging job request.
ImagingPresentationOptions
Represents the settings for displaying speaker notes and page orientation for presentation slides, such as Microsoft PowerPoint.
ImagingProfile
Represents the settings used to image a group of documents.
ImagingSet
Represents the Image Set which consists of an imaging profile and a search containing the documents to image. Necessary to run imaging job.
ImagingSetDetailedStatus
Represent the detialed status for Imaging Set.
ImagingSetJobRequest
Represents a job request sent to the imaging engine to generated a set of documents identified by a specific ImagingSet instance.
ImagingSetRequest
Represents request for ImaginingSet create and update operations.
ImagingSetStatus
Represent the Status of ImagingSet.
ImagingSpreadsheetOptions
Represents the spreadsheet options set on an ImagingProfile instance.
ImagingWordOptions
Represents the word processing options set on an ImagingProfile instance.
InstanceSetting
Represents an Instance Setting object.
ItemLevelSecurity
Represents the Relativity item level security object.
KeyboardShortcut
Represents the Keyboard Shortcut for the workspace.
KeyboardShortcutsIncludeOptions
Represents the include options for getting Keyboard Shortucts.
KeysCombination
Represent the KeysCombination for KeyboardShortcut, indicates whether additional keys are used as part of the shortcut.
KeywordSearch
Represents an instance of keyword search. Keyword search (or SQL index search) is Relativity's default search engine.
Layout
Represents a Layout.
LibraryApplication
Represents the library application object.
LibraryApplicationInstallOptions
Represents a request for creating or updating a Library Application.
LongTextField
Represents the LongText field object.
MarkupSet
Represent a markup set model.
Matter
Represents the Relativity matter object.
MessageOfTheDay
Represents the message of the day (MotD) object.
Meta
A collection of information about fields on a given static object that may have restrictions.
MultipleChoiceField
Represents the MultipleChoice field object.
MultipleObjectField
Represents the MultipleObject field object.
NamedArtifact
Represents the Relativity artifact object that has name property. Can be used as a base class for most Relativity object classes.
NamedArtifactWithGuids
Represents the Relativity artifact object that has name and guids properties. Can be used as a base class for most Relativity object classes.
NativeImagingEngineOptions
Represents the options set on an ImagingProfile for use with native imaging jobs.
NativeImportOptions
Possible native image import options.
NativeType
Represents document types in the Imaging API.
ObjectPermission
Represents the object permission.
ObjectPermissionChangeset
Represents the changeset of object permission.
ObjectPermissionsChangeset
Represents the changeset of object permissions.
ObjectType
A representation of a Relativity Object Type used for data transfer.
ObjectType.WrappedObjectType
A representation of a WrappedObjectType used for data transfer in ObjectType API.
ObjectType.WrappedRelativityApplications
A representation of a WrappedRelativityApplications used for data transfer in ObjectType API.
OcrProfile
A representation of a optical character recognition profile.
PermissionDetail
Represents the information about a specific permission.
PermissionDetailsChangeset
Represents the changeset of permission details.
Production
Represents a production model.
ProductionDataSource
Represents a DataSource that holds documents to be included in the production.
ProductionDataSourceDefaultValues
Represents a Production Data Source.
ProductionDetails
Represents the details of a production as captured by the Production Details section on the Relativity UI. Referenced by the ProductionDetails property of the Production class.
ProductionFooters
Represents the set of footers on produced page. You can add a left footer, a right footer, and a center footer.
ProductionHeaders
Represents the set of headers on produced page. You can add a left header, a right header, and a center header.
ProductionMetadata
Represents a metadata for the production created and updated by Relativity.
ProductionNumbering
Representing the numbering scheme for production documents. The Numbering property of the Production.
ProductionPlaceholder
Represents a production placeholder model.
Query
Represents the Query.
QueryResult<T>
Represents the results of the Query.
QuerySingleResult<T>
Represents the single result of the query.
ReadSingleAsyncRequest
Object representing a request body for the LayoutBuilderManager's ReadSingleAsync endpoint.
ReadSingleAsyncResult
Object representing a response from the LayoutBuilderManager's ReadSingleAsync endpoint.
RelativityApplication
Represents the relativity application object.
ResourcePool
A representation of a Relativity Resource Pool used for data transfer.
ResourceServer
A representation of a Relativity Server used for data transfer.
RunJob
Represents a script run job.
SaveFieldsAndCustomTextRequest
Object representing a request body for the LayoutBuilderManager's SaveFieldsAndCustomText endpoint.
SaveFieldsAndCustomTextResponse
Represents the response from the SaveFieldsAndCustomText endpoint.
Script
Represents a script model.
ScriptInput
Represents the input to a Relativity script.
SearchProvider
Represents a search provider.
Securable<T>
Generic class that indicates whether or not the given value is secured from the current user.
SingleChoiceField
Represents the SingleChoice field object.
SingleDocumentImagingJobRequest
Request used for running a job to image an individual documents.
SingleObjectField
Represents the SingleObject field object.
Sort
Describes how to sort Query results.
Tab
Represents a tab.
TimeStampedNamedArtifact
Represents an Artifact with the Created and LastModified system fields.
Toggle
Represents the toggle.
User
Represents the Relativity user object.
UserField
Represents the User field object.
View
Represents the view object type.
ViewAccessStatus
Gets or sets.
WholeNumberField
Represents the WholeNumber field object.
Workspace
A representation of a Relativity Workspace used for data transfer.
YesNoField
Represents the YesNo field object.
Interfaces
IFillsRequiredProperties<T>
Represents the interface for entities that can set their required properties with values.
IHasName
Represents the interface for model classes that have string Name property.
IHaveGuids
Represents the interface for model classes that have guid list.
Enums
ActionColumnDataType
Represents the available action column data types.
ActionReturnType
The available return types of a script action.
AgentLoggingLevelType
Defines the different levels of logging for Agents.
ApplicationFieldCodeOption
Specifies how an application field code is handled during Imaging processing.
ApplicationType
ApplicationType specifies the source desktop application for a FieldCode mapping.
ArtifactType
The enumeration of artifact types.
BasicCategory
Specifies the categories of file types or formats for basic imaging. Used by NativeType class.
BatchProcessAction
Represents values for batches process actions.
BooleanOperator
CriteriaOperator enumeration.
ChoiceColor
Defines the possible colors for choices.
ClientStatus
The enumeration of Client statuses.
ConditionOperator
Defines the types of comparison operators available against Criteria Conditions.
DateConditionOperator
Defines the types of comparison operators available against Criteria Date Conditions.
DateTimeRange
Defines the Range values for when the DateTimeConditionEnum is set to 'In'.
DocumentOverlayBehavior
Defines the possible strategies for overlaying documents when doing an import.
DocumentOverwriteMode
Defines the possible strategies for overwriting documents when doing an import.
FieldDisplayType
Represents the different field display types.
FieldImportBehavior
Defines the behavior of blank relational values Field on import.
FieldType
Represents the possible Field Types.
GroupType
Defines the different values for the available types of groups.
HasImagesStatus
Contains statuses of HasImages field for Document. Possible values are Yes, No, Pending, Error.
HeaderFooterType
The enum defines valid values for production header and footer types.
ImageFormatType
Specifies the image format for images generated from a specific ImagingProfile instance.
ImageSizeType
Specifies the size of images generated from a specific ImagingProfile instance.
ImagingElementOrientation
Option for orientation of a given element used by ImagingProfile.
ImagingEmailOrientation
Specifies the page orientation for images generated from an ImagingProfile instance.
ImagingIncludeElement
Specifies whether to render element or not.
ImagingJobStatus
Represents the status of the imaging job.
ImagingJobType
Represents the Job Type indicating if the Imaging job is in progress.
ImagingProfileType
Specifies the basic or native imaging option defined on an ImagingProfile instance.
ImagingSourceType
Determines the document source to be used for creating its Images.
ImagingSpreadsheetFormatting
Specifies spreadsheet formatting as a multiple choice option on the ImagingSpreadsheetOptions instance.
ImagingSpreadsheetPageOrder
Specifies the order used to render the pages in spreadsheets.
ImagingSpreadsheetPaperSizeOrientation
Specifies the paper size and orientation used to render the pages in a spreadsheet.
ImagingSpreadsheetPrintArea
Specifies a print area in a spreadsheet used for an imaging job.
ImagingSpreadsheetTextVisibility
Specifies the visibility of the text in a spreadsheet by controlling background and font color.
ImagingWordInclude
Specifies document attributes added by word processing software to include in the imaging output.
InstanceSettingValueType
Defines the different values for the type of the value for the instance setting.
KeyboardShortcutType
Represents the values for Keyboard Shortcut Type.
LayoutElementType
Represents the different layout element types.
Month
Defines the Months for when the DateTimeRange is equal to MonthOf.
NativeCategory
Specifies the categories of file types or formats for native imaging. Used by NativeType class.
NativeFileCopyMode
Specifies what to do about the native files when importing.
NativeImagingDitheringAlgorithm
Specifies the dithering algorithm used for an ImagingProfile instance.
NumberingType
The enum defines valid values for Relativity production numbering type.
ObjectPermissionKinds
The enumeration of ObjectPermission kinds.
PlaceholderImageFormat
The enum defines the valid values for placeholder image format.
PlaceholderType
The enum defines valid values for placeholder types.
ProductionStatus
The enum defines valid values for Relativity production status.
ProductionType
The enum defines valid values for Relativity production types.
RelativityApplicationInstallStatusCode
The available codes for an application install status.
ResourceServerType
Defines the different Servers that are available in Relativity.
ResourceType
The possible Resource types.
RunJobStatus
Represents the available statuses of a script run job.
ScopeType
Search Type.
SortDirection
Defines the sort direction for a Sort.
SqlFullTextLanguage
Defines the possible SQLFullTextLanguage for a workspace.
TabIconIdentifier
Defines the possible icon identifiers used when creating a tab.
TabLinkType
Idenitfies the link type of the tab.
UseImagePlaceholderOption
The enum defines valid values for Use Image Placeholder option.
UserDefaultSelectedFileType
The enumeration of User file types for default selection.
UserDocumentSkip
The enumeration of User document skip options.
UserDocumentViewer
The enumeration of User document viewer options.
UserEmailPreference
Enum of all the possible email preferences for the user's email preference.
UserSkipDefaultPreference
The enumeration of User skip default preference options.