Class ReferenceContentFile

Namespace

Acuit.Pinpoint.Services.Entities

Assembly

Acuit.Pinpoint.Services.Entities.dll

A reference content file that applies to a unit scan.

[DataContract]
public class ReferenceContentFile

Inheritance

object

ReferenceContentFile

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ReferenceContentFile(string, string)

Initializes a new instance of the ReferenceContentFile class.

public ReferenceContentFile(string referenceTypeName, string fileName)

Parameters

referenceTypeName string

The reference content type name.

fileName string

The file name of the content file on Acuit Pinpoint Server.

Exceptions

ArgumentNullException

referenceTypeName is null.

ArgumentNullException

fileName is null.

Properties

FileName

Gets the file name of the content file on Acuit Pinpoint Server.

[DataMember]
public string FileName { get; }

Property Value

string

Remarks

This will be a full path to the file, but from the perspective of Acuit Pinpoint Server. The workstation should use the Acuit Pinpoint Server file API (i.e., RetrieveFile or RetrieveFileAsync) to retrieve the file content.

Parameters

Gets the list of viewer-specific parameters.

public IList<KeyValuePair<string, string?>> Parameters { get; }

Property Value

IList<KeyValuePair<string, string>>

ReferenceTypeName

Gets the reference content type name.

[DataMember]
public string ReferenceTypeName { get; }

Property Value

string