<PackageReference Include="Relativity.Server.DocumentViewer.SDK" Version="5000.0.4" />

ViewerContentKey

public class ViewerContentKey
Represents a conversion response object that contains information about cached documents, and a property indicating whether a notification message is sent.
public long? CacheEntryID { get; set; }

Gets an identifier for a document that is cached. When this property is set, the document is available in the cache.

public string ConversionVersion { get; set; }

Gets the version of the library that converted the document.

public int DocumentArtifactID { get; set; }

Gets the Artifact ID of a document to retrieve.

public long ErrorID { get; }

The artifact Id of the error associated with the conversion of the document.

public string ErrorMessage { get; set; }

The error message, if any, associated with the conversion of the document.

public bool IsPartialConversion { get; set; }

An indicator whether or not the CacheEntryID is for a Partial Conversion

public string MinimalFilesManifest { get; set; }

A CSV of the names of the files that the OutsideIn Viewer will need, at mininum, to display any content.

public int Priority { get; set; }

The priority of the original Document Viewer Service Request.

public ViewerContentKey[] Priority2ViewerContentKeys { get; set; }

An array of viewer content keys for priority 2 requests.

public Guid? RequestKey { get; set; }

Gets a requestKey associated with a conversion request. If this property is set, SignalR sends a notification message after conversion has completed.

public int ViewerType { get; set; }

The viewer cache entry type.

public int WorkspaceArtifactID { get; set; }

The artifact Id of the workspace.

public ViewerContentKey()

Default constructor - required for serialization of Kepler DTOs

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)

Initialization constructor - populates every public property.

public ViewerContentKey(int documentArtifactID, Guid? requestKey, int priority, int workspaceArtifactID, int viewerType)

Represents a conversion response object that contains information about cached documents, and a property indicating whether a notification message is sent.

public ViewerContentKey(ViewerContentKey[] priority2ViewerContentKeys)

Setter for the P2 viewer content keys