Relativity.Server.DocumentViewer.SDK 5001.0.1

Download Package

API Differences between 5001.0.1 and 2020.13.1

204 Additions 0 Removals

Relativity.DocumentViewer.Domain.DTOs

public class PersistentHighlightTerm
- public string BackgroundColor { get; set; }
- public string ForegroundColor { get; set; }
- public string Id { get; set; }
- public long PersistentHighlightSetId { get; set; }
- public long PersistentHighlightTermId { get; set; }
- public bool Selected { get; set; }
- public string Syntax { get; set; }
- public string Term { get; set; }
- public PersistentHighlightTerm()
public class RSMFValidationDetails
- public int LineNumber { get; set; }
- public int LinePosition { get; set; }
- public string Message { get; set; }
- public List<string> Submessages { get; set; }
- public RSMFValidationDetails()
public class RSMFValidationResponse
- public List<RSMFValidationDetails> Errors { get; set; }
- public RSMFValidationStatusType Status { get; set; }
- public List<RSMFValidationDetails> Warnings { get; set; }
- public RSMFValidationResponse()

Relativity.DocumentViewer.Domain.Enums

public enum RSMFValidationStatusType
- Failed = 1
- Passed = 0
- PassedWithWarnings = 2

Relativity.DocumentViewer.Services

public interface IDocumentViewerServiceModule

Relativity.DocumentViewer.Services.Interfaces.V2.DTOs

public class Annotation : IComparable
- public int? BorderA { get; set; }
- public int? BorderB { get; set; }
- public int? BorderG { get; set; }
- public int? BorderR { get; set; }
- public int? BorderSize { get; set; }
- public int? BorderStyle { get; set; }
- public DateTime? CreatedOn { get; set; }
- public int DocumentArtifactID { get; set; }
- public bool DrawCrossLines { get; set; }
- public int? FillA { get; set; }
- public int? FillB { get; set; }
- public int? FillG { get; set; }
- public int? FillR { get; set; }
- public int? FontA { get; set; }
- public int? FontB { get; set; }
- public int? FontG { get; set; }
- public string FontName { get; set; }
- public int? FontR { get; set; }
- public int? FontSize { get; set; }
- public int? FontStyle { get; set; }
- public string Guid { get; set; }
- public decimal Height { get; set; }
- public int ID { get; set; }
- public int ImageHeight { get; set; }
- public int ImageWidth { get; set; }
- public int MarkupSetArtifactID { get; set; }
- public int MarkupSubType { get; set; }
- public int MarkupType { get; set; }
- public int ModifiedBy { get; set; }
- public int PageHeight { get; set; }
- public int PageNumber { get; set; }
- public int PageWidth { get; set; }
- public string Text { get; set; }
- public bool ValuesAreScaledToDB { get; set; }
- public decimal Width { get; set; }
- public int WorkspaceID { get; set; }
- public decimal X { get; set; }
- public decimal Y { get; set; }
- public int ZOrder { get; set; }
- public Annotation()
- public int CompareTo(object obj)
public class AnnotationList
- public List<Annotation> Annotations { get; set; }
- public AnnotationList()
public class CustomErrorReturnClass
- public string CustomErrorMessage { get; set; }
- public int ErrorCode { get; set; }
- public bool Success { get; set; }
- public CustomErrorReturnClass()
- public CustomErrorReturnClass(int errorCode)
- public CustomErrorReturnClass(int errorCode, string customErrorMessage)
public class ImageWidthAndHeightModel
- public int Height { get; set; }
- public int Width { get; set; }
- public ImageWidthAndHeightModel()
public class SaveAnnotationsReturnObject : CustomErrorReturnClass
- public int[] AnnotationIDs { get; set; }
- public SaveAnnotationsReturnObject()
- public SaveAnnotationsReturnObject(int[] annotationIds)
- public SaveAnnotationsReturnObject(int errorCode)
- public SaveAnnotationsReturnObject(int errorCode, string customErrorMessage)
- public SaveAnnotationsReturnObject(bool success, int[] annotationIds, string customErrorMessage, int errorCode)

Relativity.DocumentViewer.Services.V2

public class AddHighlightTermsToSetRequest
- public string BackgroundColor { get; set; }
- public string ForegroundColor { get; set; }
- public string Term { get; set; }
- public AddHighlightTermsToSetRequest(string term, string backgroundColor, string foregroundColor)
public class AttachmentInfo
- public string AttachmentID { get; set; }
- public int DocumentArtifactID { get; set; }
- public string FileGuid { get; set; }
- public AttachmentInfo()
public enum ConversionType
- HTMLImage = 5
- HTMLProduction = 6
- Image = 2
- Native = 1
- None = 0
- Production = 3
- Text = 7
- Transcript = 4
public class GetViewerContentKeyOptions
- public string ClientID { get; set; }
- public Guid CorrelationID { get; set; }
- public string DocumentSetID { get; set; }
- public int? FileID { get; set; }
- public bool? ForceConversion { get; set; }
- public int? ProductionID { get; set; }
- public GetViewerContentKeyOptions()
public class GetViewerContentKeyRequest
- public ConversionType ConversionType { get; set; }
- public List<int> DocumentIDs { get; set; }
- public GetViewerContentKeyOptions Options { get; set; }
- public PriorityLevel Priority { get; set; }
- public int WorkspaceID { get; set; }
- public GetViewerContentKeyRequest()
public interface IAnnotationServiceManager : IDisposable
- Task Delete(int workspaceID, int[] annotationIds, int documentID, int markUpSetID)
- Task<Dictionary<string, AnnotationList>> Get(int workspaceID, int documentID, int markUpSetID)
- Task<Dictionary<string, ImageWidthAndHeightModel>> GetGroupLegacyHeightAndWidth(int workspaceID, Dictionary<string, string> pageNumberAndDocumentGuid)
- Task<SaveAnnotationsReturnObject> Save(int workspaceID, Annotation[] annotations)
public interface IDocumentViewerServiceManager : IDisposable
- Task<ViewerContentKey> GetViewerContentKeyAsync(GetViewerContentKeyRequest request)
public interface IPersistentHighlightServiceManager : IDisposable
- Task<int> AddPersistentHighlightTermsToSet(int workspaceID, int persistentHighlightSetID, IEnumerable<AddHighlightTermsToSetRequest> terms)
- Task<IEnumerable<PersistentHighlightSetDTO>> GetPersistentHighlightSets(int workspaceID, int documentID)
- Task<IEnumerable<PersistentHighlightSetDTO>> GetPersistentHighlightSets(int workspaceID)
- Task SavePersistentHighlightSetState(int workspaceID, int persistentHighlightSetID, IEnumerable<int> termIDs, PersistentHighlightStateAction action)
public interface IShortMessageViewerManager : IDisposable
- Task<IEnumerable<AttachmentInfo>> GetAttachmentInfo(int workspaceID, int documentID, string[] attachmentIDs)
- Task<IKeplerStream> GetMessageJson(int workspaceID, int documentID)
- Task<IEnumerable<ParticipantResponseInfo>> GetParticipantInfo(int workspaceID, ParticipantRequestInfo[] participantRequests)
- Task SliceRSMF(int workspaceID, int documentID, SliceRequest sliceRequest)
- Task<RSMFValidationResponse> ValidateRSMF(string fileName, IKeplerStream file)
- Task<RSMFValidationResponse> ValidateRSMF(int workspaceID, int documentID)
- Task WakeUpAgent()
public class ParticipantRequestInfo
- public string Email { get; set; }
- public string Name { get; set; }
- public string ParticipantID { get; set; }
- public ParticipantRequestInfo()
public class ParticipantResponseInfo
- public List<string> Aliases { get; set; }
- public string EntityName { get; set; }
- public string ParticipantID { get; set; }
- public string Url { get; set; }
- public ParticipantResponseInfo()
public class PersistentHighlightSetDTO
- public bool Expanded { get; set; }
- public bool HasEditPermission { get; set; }
- public int Order { get; set; }
- public long PersistentHighlightSetID { get; set; }
- public IEnumerable<PersistentHighlightTerm> PersistentHighlightTerms { get; set; }
- public bool Selected { get; set; }
- public string SetID { get; set; }
- public string SetName { get; set; }
- public string Syntax { get; set; }
- public PersistentHighlightSetDTO(string setName, string id, int setArtifactID, bool expanded, bool selected, int order, IEnumerable<PersistentHighlightTerm> terms, bool hasEditPermission, string syntax)
public enum PersistentHighlightStateAction
- Collapsed = 4
- Disabled = 2
- Enabled = 1
- Expanded = 3
- None = 0
public enum PriorityLevel
- ConvertAhead = 2
- MassConvert = 3
- None = 0
- OnTheFly = 1
public class SliceRequest
- public Guid? CorrelationId { get; set; }
- public List<int> EventIndexes { get; set; }
- public SliceRequestOptions Options { get; set; }
- public SliceRequest()
public class SliceRequestOptions
- public bool? CreateAttachments { get; set; }
- public bool? EmailConfirmation { get; set; }
- public bool? PreserveAllParticipants { get; set; }
- public int? SourceLayoutID { get; set; }
- public SliceRequestOptions()
public class ViewerContentKey
- public long? CacheEntryID { get; set; }
- public string ConversionVersion { get; set; }
- public int DocumentArtifactID { get; set; }
- public long ErrorID { get; }
- public string ErrorMessage { get; set; }
- public bool IsPartialConversion { get; set; }
- public string MinimalFilesManifest { get; set; }
- public int Priority { get; set; }
- public ViewerContentKey[] Priority2ViewerContentKeys { get; set; }
- public Guid? RequestKey { get; set; }
- public int ViewerType { get; set; }
- public int WorkspaceArtifactID { get; set; }
- public ViewerContentKey()
- public ViewerContentKey(int documentArtifactID, long? cacheEntryID, string conversionVersion, Guid? requestKey, int priority, int workspaceArtifactID, int viewerType, ViewerContentKey[] priority2ViewerContentKeys, string minimalFilesManifest, long errorID, bool isPartialConversion, string errorMessage)
- public ViewerContentKey(int documentArtifactID, Guid? requestKey, int priority, int workspaceArtifactID, int viewerType)
- public ViewerContentKey(ViewerContentKey[] priority2ViewerContentKeys)