Relativity.ObjectManager 9.5.104.50 - API Reference

<PackageReference Include="Relativity.ObjectManager" Version="9.5.104.50" />

API Differences between 9.5.104.50 and 9.5.309.48

75 Additions 107 Removals

Relativity.Kepler.Logging

public static class Log
public class OutputWindowLogger : ILog

Relativity.Services

public interface ISortAssociable
public class Query
- public int? ExecutingSavedSearchId { get; set; }
- public string QueryHint { get; set; }
- public string RankSortOrder { get; set; }
public class DeleteProcessStateProgress

Relativity.Services.Analytics

public class AnalyticsIndex : SearchIndexRef
- public AnalyticsProfileRef AnalyticsProfile { get; set; }
- public ResourceServerRef AnalyticsServer { get; set; }
- public bool AutomaticallyRemoveEnglishEmailSignaturesAndFooters { get; set; }
- public List<string> EmailNotificationRecipients { get; set; }
- public bool OptimizeTrainingSet { get; set; }
- public int Order { get; set; }
- public SavedSearchRef SearchableSet { get; set; }
- public SavedSearchRef TrainingSet { get; set; }
- public AnalyticsIndex()
public class AnalyticsIndexJobParameters
- public bool? AutomaticallyRemoveDocumentsInError { get; set; }
- public AnalyticsIndexJobType? FinalAutomationStage { get; set; }
- public AnalyticsIndexJobType JobType { get; set; }
- public AnalyticsIndexJobParameters()
public enum AnalyticsIndexJobType
- ActivateIndex = 5
- BuildIndex = 3
- DisableQueries = 7
- EnableQueries = 4
- FullBuild = 0
- IncrementalBuild = 1
- RemoveDocumentsInError = 6
- ResolveErrors = 2
- StopAutomation = 8
- StopPopulation = 9
- StopRetryErrors = 10
public class AnalyticsProfileRef
- public int ArtifactID { get; set; }
- public string Name { get; set; }
- public AnalyticsProfileRef()
public interface IAnalyticsModule
public interface IIndexManager : IDisposable
- Task<AnalyticsIndex> CreateAsync(int workspaceID, AnalyticsIndex index)
- Task<AnalyticsIndex> CreateAsync(Guid workspaceGuid, AnalyticsIndex index)
- Task DeleteAsync(int workspaceID, int indexID)
- Task DeleteAsync(Guid workspaceGuid, int indexID)
- Task SubmitJobAsync(int workspaceID, int indexID, AnalyticsIndexJobParameters parameters)
- Task SubmitJobAsync(Guid workspaceGuid, int indexID, AnalyticsIndexJobParameters parameters)

Relativity.Services.Batching

public class AutoBatchProgress
public class AutoBatchSettings
public class BatchSet : BatchSetRef
public class BatchSetRef
public class DataSource
public class FullBatchSetAndStatus
public class SecurableField : FieldRef

Relativity.Services.DashboardObject

public class Dashboard
- public int ArtifactID { get; set; }
- public List<Guid> Guids { get; set; }
- public string Name { get; set; }
public class DashboardRef
public class DeleteStatus

Relativity.Services.DataContracts.DTOs.Results

public class UniqueFieldValuesResult

Relativity.Services.DataContracts.DTOs.Results.StaticObject

public class BrandingQueueStatus
public enum BrandingQueueStatusEnum
public class FailedApplicationInstall
public class OCRQueueStatus
public class WorkspaceUpgradeQueueCode

Relativity.Services.DataContracts.DTOs.Search

public class SearchContainerTreeFilter

Relativity.Services.Document

public class File
- public int FileID { get; set; }
- public string Filename { get; set; }

Relativity.Services.DocumentPrintData

public interface IDocumentPrintDataManager : IDisposable
public interface IDocumentPrintDataModule

Relativity.Services.Exceptions

public class InvalidInputException : ValidationException
public class ValidationError

Relativity.Services.Field

public class MultipleObjectFieldUpdateValue
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
- public IEnumerable<RelativityObjectRef> Objects { get; set; }
public class SecurityFieldRef : FieldRef
public class SecurityFieldValue

Relativity.Services.FieldManager

public interface IFieldManager : IDisposable
public interface IFieldModule

Relativity.Services.Files

public class FileRef

Relativity.Services.ItemListView

public class ItemListFieldRef : FieldRef
- public bool IsVisible { get; set; }
- public List<Guid> SourceFieldArtifactGuids { get; set; }

Relativity.Services.ObjectQuery

public class Query
- public string QueryHint { get; set; }
- public string RankSortOrder { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }

Relativity.Services.Objects

public interface IObjectManager : IDisposable
public interface IObjectModule

Relativity.Services.Objects.Exceptions

public class EventHandlerFailedException : ServiceException

Relativity.Services.Objects.Models

public enum DeleteOperations
public class DeleteOptions
public class ObjectDependency
public class RelativityObject : RelativityObjectRef
public class RelativityObjectRef
public class EventHandlerStatus
public class ObjectCreateResult
public class ObjectDeleteResult
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>
public class ObjectReadResult
public class ObjectUpdateResult
public class Query : Query

Relativity.Services.Objects.Models.WebContent

public class CallingContext
public class LayoutMetadata
public enum PageMode

Relativity.Services.Objects.Serialization

public class FieldRefSerializer : IModelSerializer<FieldRef>, IModelSerializer
public class FieldValuePairSerializer : IModelSerializer<FieldValuePair>, IModelSerializer

Relativity.Services.Permission

public class PermissionType : IEquatable<PermissionType>
- public static readonly PermissionType Manage

Relativity.Services.Proxy.Routing

public class RouteBuilder
- public RouteInfo GetRouteInfoBase(Type serviceModuleIntType, Type serviceIntType, MethodInfo targetIntMethod)

Relativity.Services.RelativityObject

public class Query : Query
- public int? ActiveArtifactID { get; set; }
- public bool? ConvertNumberFieldValuesToString { get; set; }
- public int? ExecutingSavedSearchID { get; set; }
- public int? ExecutingViewID { get; set; }
- public IEnumerable<FieldRef> Fields { get; set; }
- public bool? IsAdhocQuery { get; set; }
- public bool? TruncateTextFields { get; set; }
- public Query()
public class RelativityObject : RelativityObjectRef
- public IEnumerable<FieldValuePair> FieldValuePairs { get; set; }
- public int? ParentArtifactID { get; set; }
- public RelativityObject()
public class RelativityObjectRef
- public int ArtifactID { get; set; }
- public string DisplayText { get; set; }
- public IEnumerable<Guid> Guids { get; set; }
- public RelativityObjectRef()
public class ObjectQueryResultSet : QueryResultSet<RelativityObject>
- public int CurrentStartIndex { get; set; }
- public IEnumerable<int> IDWindow { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
- public int ResultCount { get; set; }
- public SampleDetails Sample { get; set; }
- public ObjectQueryResultSet()
public class ObjectUpdateResult
- public ObjectUpdateResult()

Relativity.Services.ResourceServer

public class FileShareResourceServer : ResourceServerRef

Relativity.Services.Review

public interface IBatchingManager : IDisposable
public interface IReviewModule

Relativity.Services.Search

public class AnalyticsSearch : SavedSearchRef, ISavedSearch
- public DashboardRef Dashboard { get; set; }
public class DataGridSearch : SavedSearchRef, ISavedSearch
- public DashboardRef Dashboard { get; set; }
public class dtSearch : SavedSearchRef, ISavedSearch
- public DashboardRef Dashboard { get; set; }
public interface ISearchCriteriaAssociable
public class KeywordSearch : SavedSearchRef, ISavedSearch
- public DashboardRef Dashboard { get; set; }
public class SearchProviderCondition
- public string SortOrder { get; set; }
public class AdvancedSearchViewInfo
public interface ISearchContainerManager : IDisposable
- Task<AdvancedSearchViewInfo> GetAdvancedSearchViewInfoAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueCreatedByAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueModifiedByAsync(int workspaceArtifactID)
- Task<List<UserRef>> GetAdvancedSearchViewUniqueOwnersAsync(int workspaceArtifactID)
- Task<SearchContainerItemCollection> GetFilteredWithAdvancedOptionsSearchContainerTreeAsync(int workspaceArtifactID, SearchContainerTreeFilter filter)
public class SearchProvider
- public string BasicSearchMarkupId { get; set; }

Relativity.Services.Serialization

public class ChoiceRefHelper : IChoiceRefHelper
public class DateHelper : IDateHelper
public class FileRefHelper : IFileRefHelper
public interface IChoiceRefHelper
public interface IDateHelper
public interface IFileRefHelper
public interface IRelativityObjectRefHelper
public interface IUserRefHelper
public class RelativityObjectRefHelper : IRelativityObjectRefHelper
public class UserRefHelper : IUserRefHelper

Relativity.Services.StaticObject

public class BrandingQueueItem
public class OCRQueueItem
public class ProductionQueueItem
public class StaticObjectQuery
public class UserStatusListItem
public class WorkerManagerQueueItem
public class WorkspaceUpgradeQueueItem
public enum WorkspaceUpgradeQueueProgressType
public class BrandingQueueQueryResultSet
public class BrandingSetQueueSubmitter
public class OCRQueueQueryResultSet
public class PermissionResultSet
public class ProductionQueueQueryResultSet
public class ProductionSetQueueSubmitter
public class StartupInfoResultSet
public class UserSettingsResult
public class UserStatusQueryResultSet
public class WorkerManagerQueueQueryResultSet
public class WorkspaceUpgradeQueueQueryResultSet

Relativity.Services.View

public class View : ViewRef, IViewFieldAssociable, IRelativityApplicationAssociable
- public bool IsRelationalFieldView { get; set; }
- public ObjectTypeRef ObjectType { get; set; }
public interface IViewManager : IDisposable
public interface IViewModule
public class ViewAccessStatus