The Relativity.Services.Objects.DataContracts namespace contains the classes and enumerations used to interact with data when performing create, read, update, delete, and query operations through the Object Manager service.
Classes
| Class | Description | |
|---|---|---|
| CallingContext |
Represents information about the web context from which the event handler is being called, such as the layout or page mode.
| |
| Choice |
Represents the value for choice fields.
| |
| ChoiceRef |
Represents a key or reference to a Choice object.
| |
| CreateRequest |
Represents a request to create a Relativity Dynamic Object (RDO).
| |
| CreateResult |
Represents the results of a create operation.
| |
| DeleteItem |
Provides information about each item that was deleted.
| |
| DeleteProcessStateProgress |
Represents the progress object for mass delete processes.
| |
| DeleteReport |
Contains information about deleted objects as a list of one or more deleted items.
| |
| DeleteRequest |
Represents a request to delete a Document or Relativity Dynamic Object (RDO).
| |
| DeleteResult |
Represents the results of a delete operation.
| |
| DependencyListByObjectIdentifiersRequest |
Represents a request for information about objects dependent on one or more Relativity Objects.
| |
| EventHandlerStatus |
Contains a message and operation status returned by an event handler.
| |
| Field |
Represents a field used to store metadata, choices, and other information in Relativity.
| |
| FieldRef |
Represents a key or reference to a Field object.
| |
| FieldRefValuePair |
Represents a key or reference to a Field object and the value currently assigned to it.
| |
| FieldValuePair |
Represents a field and the value currently assigned to it.
| |
| FileObject |
Represents a file used as a value for file fields in Relativity.
| |
| Layout |
Represents a Layout that contains fields used for coding and other purposes in the Relativity UI.
| |
| LayoutRef |
Represents a key or reference to a Layout object.
| |
| MassCreateRequest |
Represents a request to create a multiple Relativity Dynamic Objects (RDOs).
| |
| MassCreateResult |
Represents the results of a mass create operation.
| |
| MassDeleteByCriteriaRequest |
Represents a request to perform a mass delete operation on all Documents or Relativity Dynamic Objects (RDOs) that meet a specified set of conditions.
| |
| MassDeleteByObjectIdentifiersRequest |
Represents a request to delete multiple Documents or Relativity Dynamic Objects (RDOs).
| |
| MassDeleteResult |
Represents the results of a mass delete operation.
| |
| MassOperationsStateProgress |
Represents the progress object for mass operations processes.
| |
| MassUpdateByCriteriaRequest |
Represents a request to perform a mass update operation on all Documents or Relativity Dynamic Objects (RDOs) that meet a specified set of conditions.
| |
| MassUpdateByObjectIdentifiersRequest |
Represents a request to perform a mass update operation on a list of Documents or Relativity Dynamic Objects (RDOs)
by modifying each of the specified object fields with the same value.
| |
| MassUpdateOptions |
Represents information about how a mass update request is performed by replacing or merging field values.
| |
| MassUpdatePerObjectsRequest |
Represents a request to perform a mass update operation on a list of Documents or Relativity Dynamic Objects (RDOs) by
modifying each of the specified object fields with a distinct value.
| |
| MassUpdateResult |
Represents the results of a mass update operation.
| |
| ObjectIdentificationCriteria |
Represents a set of query conditions used to identify a RelativityObjectRef object.
| |
| ObjectRefValuesPair |
Represents a key or reference to a pair of RelativityObjectRefs objects and their associated field values.
| |
| ObjectType |
Represents a custom object type added to a workspace.
| |
| ObjectTypeRef |
Represents a key or reference to an ObjectType object.
| |
| OperationOptions |
Represents information about how an operation for a request is being called.
| |
| QueryRequest |
Describes conditions, sorts and fields to be returned for a query.
| |
| QueryResult |
Represents the results of a QueryRequest returned by the QueryAsync() method.
| |
| QueryResultSlim |
Represents the results of a QueryRequest returned by the QuerySlimAsync() method.
| |
| ReadOptions |
Represents information about how long text fields are handled during read operations.
| |
| ReadRequest |
Represents the request for a read operation on Document objects and RDOs.
| |
| ReadResult |
Represents the results of a read operation performed through the Object Manager service.
| |
| RelativityObject |
Represents an object in Relativity.
| |
| RelativityObjectRef |
Represents the minimal information needed to uniquely identify a RelativityObject.
| |
| RelativityObjectSlim |
Represents a streamlined RelativityObject with values that map to fields on a QueryResultSlim object.
| |
| RelativityObjectValue |
Represents the value for an object field.
| |
| SampleDetails |
Contains information used to define a sample set.
| |
| SampleParameters |
Contains information about how the sampling is performed.
| |
| SearchIndexRef |
Represents a key or reference to a search provider.
| |
| SearchProviderCondition |
Contains the parameters used to execute a query through a search provider.
| |
| SecuredReflectedFieldValue |
Represents a value from a field reflected from a secured object relationship.
| |
| Security |
Represents information about inherited security settings and user permissions on a specific object.
| |
| Sort |
Represents sorting information for query results.
| |
| TextFieldError |
Represents a value for a text field that could not be properly returned.
| |
| UpdateLongTextFromStreamRequest |
Represents a request object which is used to update a field value from a stream.
| |
| UpdateOptions |
Represents information about how an update request is performed.
| |
| UpdateRequest |
Represents an update request for a Document or Relativity Dynamic Object (RDO).
| |
| UpdateResult |
Represents the results of an update operation.
| |
| User |
Represents the value of a user field.
| |
| WordListCondition |
Condition generated by Liquid Item List on Dictionary UI
| |
| WordListFieldCondition |
Filtering condition generated by Liquid Item List on Dictionary UI
| |
| WordListSort |
Sort generated by Liquid Item List on Dictionary UI
|
Interfaces
| Interface | Description | |
|---|---|---|
| IObjectType | ||
| IRelativityObject |
Enables a class to return field-value pairs.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| FieldCategory |
Specifies the category of a field.
| |
| FieldType |
Specifies the type of a Relativity field, such as fixed-length text, date, single object etc.
| |
| FieldUpdateBehavior |
Specifies how to update multiple choice and multiple object fields.
| |
| LongTextBehavior |
Controls the behavior that is used when a Long Text field exceeds the configured character limit.
| |
| PageMode |
Indicates the step in the page workflow in which a call to the event handler originates.
| |
| SortEnum |
Specifies whether query results are sorted in ascending or descending order.
|