Relativity.API 17.0.4 - API Reference

<PackageReference Include="Relativity.API" Version="17.0.4" />

API Differences between 17.0.4 and 19.5.0

0 Additions 137 Removals

Relativity.API

public class UnhandledEventHandlerException : Exception

Relativity.API.Foundation

public enum DependencyAction
public enum DependencyRelationship
public interface IDependencyTreeNode
public interface ILayout : IArtifactRef
public interface ISearchRef : IArtifactRef
public interface IUploadedFile
public interface IUserFieldInfo
public interface IViewRef : IArtifactRef
public enum LongTextBehavior
public class LongTextRenderingOptions
public enum PageMode
public class ReadOptions

Relativity.API.Foundation.EventHandlers

public interface ICallingContext
public interface IEventHandlerDetails
public interface IEventHandlerResponse : IEventHandlerDetails
public interface IFieldCollection : IReadOnlyCollection<IField>, IEnumerable<IField>, IEnumerable
public interface IObjectEventHandler : IObjectEventHandlerRef, IArtifactRef, IEventHandlerDetails
public interface IObjectEventHandlerRef : IArtifactRef, IEventHandlerDetails
public interface IPostSave : IObjectEventHandler, IObjectEventHandlerRef, IArtifactRef, IEventHandlerDetails
public interface IPreLoad : IObjectEventHandler, IObjectEventHandlerRef, IArtifactRef, IEventHandlerDetails
public interface IPreSave : IObjectEventHandler, IObjectEventHandlerRef, IArtifactRef, IEventHandlerDetails
public enum PostSaveOperationType
public enum RequiredFieldsType

Relativity.API.Foundation.Extension

public static class FieldRefExtensions

Relativity.API.Foundation.MassOperations

public interface IMergeBuilder : IMassOperationBuilderWithObjectList<IMassOperation, IArtifactRef, IMergeParameters>, IMassOperationBuilder, IContextualInformation
public interface IMergeParameters
public interface IPropagateToFieldGrouping
public interface IPropagationBuilder : IMassOperationBuilderWithObjectList<IMassOperation, IPropagateToFieldGrouping, IPropagationParameters>, IMassOperationBuilder, IContextualInformation
public interface IPropagationParameters
public enum OperationState
- NotStarted = 9
- Paused = 11
- Pausing = 10

Relativity.API.Foundation.Permissions

public interface IPermissionChecker : IContextualInformation
- bool HasObjectTypePermission(IObjectTypeRef objectTypeRef, PermissionType permission)

Relativity.API.Foundation.Query

public sealed class ArtifactRenderingOptions
public static class BooleanConditionExtensions
public static class CurrencyConditionExtensions
public static class DateTimeConditionExtensions
public static class DecimalConditionExtensions
public interface IDisplayableArtifactRef : IArtifactRef
public interface INonQueryResponse
public interface IQuery
public interface IQueryOptions
public interface IQueryResponse : INonQueryResponse
public interface IQuerySort
public interface IResult
public interface IScratchTableInfo
public interface ISecuredValue
public interface ISortDirection<T>
public static class MultipleChoiceExtensions
public static class MultipleObjectExtensions
public static class SearchProviderConditionExtensions
public static class SingleChoiceExtensions
public static class SingleObjectExtensions
public enum SortDirection
public static class TextConditionExtensions
public static class UserConditionExtensions
public static class WholeNumberExtensions

Relativity.API.Foundation.Query.Conditions

public class AllCondition : CompositeCondition
public class AnyCondition : CompositeCondition
public abstract class BaseFieldCondition : Condition
public class BetweenCondition<T> : BaseFieldCondition
public abstract class CompositeCondition : Condition, IList<Condition>, ICollection<Condition>, IEnumerable<Condition>, IEnumerable
public abstract class Condition
public class CurrentUserCondition : BaseFieldCondition
public class HasValueCondition : BaseFieldCondition
public class MonthOfDateCondition : BaseFieldCondition
public enum Operator
public class RelativeDateCondition : BaseFieldCondition
public class ScratchTableSubQuery : BaseFieldCondition
public class SearchCondition : Condition
public class SearchProviderCondition : Condition
public class SimpleCondition<T> : BaseFieldCondition
public class SubQueryCondition : BaseFieldCondition
public enum TimeFrame
public class ViewCondition : Condition

Relativity.API.Foundation.Query.SyntaxBuilders

public interface IAllConditionBuilder<T, U>
public interface IAnyConditionBuilder<T, U>
public interface IBaseConditionSelector<T>
public interface IBetweenConditionBuilder<T, U>
public interface IBooleanConditionBuilder<T> : IIsTransition<IBooleanIsConditionBuilder<T>>
public interface IBooleanIsConditionBuilder<T> : ISetConditionBuilder<T>, IEqualToConditionBuilder<T, bool>, INotConditionBuilder<IBooleanIsConditionBuilder<T>>
public interface ICanAddCondition : ICanAddSort, ICanBuild
public interface ICanAddFields : ICanAddCondition, ICanAddSort, ICanBuild, ICanInclude<ICanAddCondition>
public interface ICanAddSort : ICanBuild
public interface ICanBuild
public interface ICanInclude<T>
public interface IComparableConditionBuilder<T, U> : IEqualToConditionBuilder<T, U>
public interface IConditionBuilder<T> : IConditionSelector<T>, IIsTransition<IInTransition<IBaseConditionSelector<T>>>
public interface IConditionSelector<T> : IIsTransition<IInTransition<IBaseConditionSelector<T>>>
public interface ICurrencyConditionBuilder<T> : INumericConditionBuilder<T, decimal>, IIsTransition<INumericIsConditionBuilder<T, decimal>>
public interface IDateTimeConditionBuilder<T> : IIsTransition<IDateTimeIsConditionBuilder<T>>
public interface IDateTimeIsConditionBuilder<T> : ISetConditionBuilder<T>, IBetweenConditionBuilder<T, DateTime>, IInTransition<ITimeFrameConditionBuilder<T>>, IComparableConditionBuilder<T, DateTime>, IEqualToConditionBuilder<T, DateTime>, INotConditionBuilder<IDateTimeIsConditionBuilder<T>>
public interface IDecimalNumberConditionBuilder<T> : INumericConditionBuilder<T, decimal>, IIsTransition<INumericIsConditionBuilder<T, decimal>>
public interface IDoesTransition<T>
public interface IEqualToConditionBuilder<T, U>
public interface IInTransition<T>
public interface IIsTransition<T>
public interface ILikeConditionBuilder<T>
public interface IMultipleChoiceConditionBuilder<T> : IIsTransition<IMultipleChoiceIsConditionBuilder<T>>
public interface IMultipleChoiceIsConditionBuilder<T> : ISetConditionBuilder<T>, IAnyConditionBuilder<T, int>, IAnyConditionBuilder<T, Guid>, IAnyConditionBuilder<T, IArtifactRef>, IAllConditionBuilder<T, int>, IAllConditionBuilder<T, Guid>, IAllConditionBuilder<T, IArtifactRef>, INotConditionBuilder<IMultipleChoiceIsConditionBuilder<T>>
public interface IMultipleObjectConditionBuilder<T> : IIsTransition<IMultipleObjectIsConditionBuilder<T>>
public interface IMultipleObjectIsConditionBuilder<T> : ISetConditionBuilder<T>, IEqualToConditionBuilder<T, int>, IEqualToConditionBuilder<T, Guid>, IEqualToConditionBuilder<T, IArtifactRef>, IAnyConditionBuilder<T, int>, IAnyConditionBuilder<T, Guid>, IAnyConditionBuilder<T, IArtifactRef>, IAllConditionBuilder<T, int>, IAllConditionBuilder<T, Guid>, IAllConditionBuilder<T, IArtifactRef>, INotConditionBuilder<IMultipleObjectIsConditionBuilder<T>>, ISubQueryConditionBuilder<T>
public interface IMustAddFields
public interface INotConditionBuilder<T>
public interface INumericConditionBuilder<T, U> : IIsTransition<INumericIsConditionBuilder<T, U>>
public interface INumericIsConditionBuilder<T, U> : ISetConditionBuilder<T>, IBetweenConditionBuilder<T, U>, IComparableConditionBuilder<T, U>, IEqualToConditionBuilder<T, U>, IAnyConditionBuilder<T, U>, INotConditionBuilder<INumericIsConditionBuilder<T, U>>
public interface IPatternConditionBuilder<T>
public interface IQueryBuilder
public interface ISetConditionBuilder<T>
public interface ISingleChoiceConditionBuilder<T> : IIsTransition<ISingleChoiceIsConditionBuilder<T>>
public interface ISingleChoiceIsConditionBuilder<T> : ISetConditionBuilder<T>, IEqualToConditionBuilder<T, int>, IEqualToConditionBuilder<T, Guid>, IEqualToConditionBuilder<T, IArtifactRef>, IAnyConditionBuilder<T, int>, IAnyConditionBuilder<T, Guid>, IAnyConditionBuilder<T, IArtifactRef>, INotConditionBuilder<ISingleChoiceIsConditionBuilder<T>>
public interface ISingleObjectConditionBuilder<T> : IIsTransition<ISingleObjectIsConditionBuilder<T>>, IDoesTransition<ISingleObjectDoesConditionBuilder<T>>
public interface ISingleObjectDoesConditionBuilder<T> : IPatternConditionBuilder<T>, INotConditionBuilder<ISingleObjectDoesConditionBuilder<T>>
public interface ISingleObjectIsConditionBuilder<T> : ISetConditionBuilder<T>, IEqualToConditionBuilder<T, Guid>, IEqualToConditionBuilder<T, int>, IEqualToConditionBuilder<T, string>, IEqualToConditionBuilder<T, IArtifactRef>, IAnyConditionBuilder<T, int>, IAnyConditionBuilder<T, Guid>, IAnyConditionBuilder<T, string>, IAnyConditionBuilder<T, IArtifactRef>, INotConditionBuilder<ISingleObjectIsConditionBuilder<T>>, ILikeConditionBuilder<T>, ISubQueryConditionBuilder<T>
public interface ISubQueryConditionBuilder<T>
public interface ITextConditionBuilder<T> : IIsTransition<ITextIsConditionBuilder<T>>, IDoesTransition<ITextDoesConditionBuilder<T>>
public interface ITextDoesConditionBuilder<T> : IPatternConditionBuilder<T>, INotConditionBuilder<ITextDoesConditionBuilder<T>>
public interface ITextIsConditionBuilder<T> : ISetConditionBuilder<T>, IBetweenConditionBuilder<T, string>, IEqualToConditionBuilder<T, string>, IComparableConditionBuilder<T, string>, ILikeConditionBuilder<T>, INotConditionBuilder<ITextIsConditionBuilder<T>>
public interface ITimeFrameConditionBuilder<T>
public interface IUserConditionBuilder<T> : IIsTransition<IUserIsConditionBuilder<T>>
public interface IUserIsConditionBuilder<T> : ISetConditionBuilder<T>, INotConditionBuilder<IUserIsConditionBuilder<T>>
public interface IWholeNumberConditionBuilder<T> : INumericConditionBuilder<T, int>, IIsTransition<INumericIsConditionBuilder<T, int>>

Relativity.API.Foundation.Repositories

public interface IChoiceRepository : IRepository, IContextualInformation
- IEnumerable<IChoice> RetrieveAllForField(IFieldRef fieldRef)
public interface IEventHandlerRepository : IRepository, IContextualInformation
public interface IFieldRepository : IRepository, IContextualInformation
- int CreateMultiObjectFields(IField originalField, IField siblingField)
- IEnumerable<IField> GetRelationalPropagateToFields(IFieldRef fieldRef)
public interface IObjectRepository : IRepository, IContextualInformation
- IDependencyTreeNode GetDependencyTree(IEnumerable<IArtifactRef> artifacts)
- IDependencyTreeNode GetDependencyTree(string tableName, string columnName, IObjectTypeRef objectType)
- StreamReader GetLongTextStream(IArtifactRef artifactRef, IFieldRef field)
- StreamReader GetLongTextStream(IArtifactRef artifactRef, IFieldRef field, CancellationToken cancellationToken)
- IRelativityObject Read(IArtifactRef artifactRef, IEnumerable<IFieldRef> fields, CancellationToken cancellationToken)
- IRelativityObject Read(IArtifactRef artifactRef, IEnumerable<IFieldRef> fields, ReadOptions readOptions)
- IRelativityObject Read(IArtifactRef artifactRef, IEnumerable<IFieldRef> fields, ReadOptions readOptions, CancellationToken cancellationToken)
public interface IObjectTypeCacheRepository : IRepository, IContextualInformation
- IObjectType RetrieveObjectTypeByArtifactTypeIdentifier(IObjectTypeRef objectTypeRef)
public interface IQueryGateway : IRepository, IContextualInformation
public interface IUserRepository : IRepository, IContextualInformation