Class VersionInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for VersionInfo. An instance of this class represents information about one version of one document

public class VersionInfo

Inheritance

object ← VersionInfo

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

VersionInfo()

Default constructor - defaults any enum props to 0.

public VersionInfo()

Properties

CheckedInByAssociateId

Associate id of the user who performed the checkin

public virtual int CheckedInByAssociateId { get; set; }

Property Value

int

CheckedInByName

Name (nicely formatted) of the user/person who performed the checkin

public virtual string CheckedInByName { get; set; }

Property Value

string

CheckedInDate

The date that this version was checked in and became official

public virtual DateTime CheckedInDate { get; set; }

Property Value

DateTime

Description

Arbitrary description string

public virtual string Description { get; set; }

Property Value

string

DisplayText

A short description, suitable for display in a popup menu or dropdown list of versions.

public virtual string DisplayText { get; set; }

Property Value

string

DocumentId

The document Id that uniquely identifies the document within the SuperOffice database

public virtual int DocumentId { get; set; }

Property Value

int

ExternalReference

The document plugin’s key that uniquely identifies a document; stored in the externalReference field of the document table

public virtual string ExternalReference { get; set; }

Property Value

string

ExtraFields

Private metadata, owned by the document plugin. This set of metadata is related directly to the version that this VersioNinfo structure describes; metadata related to the document as a whole is retrieved using the SuperOffice.CRM.Documents.IDocumentPlugin2.LoadMetaData method. The string should be formatted like a query string, i.e., name1=value1&name2=value2… - this format, instead of a string/string dictionary avoids serialization problems, even though it is somewhat less efficient

public virtual string[] ExtraFields { get; set; }

Property Value

string[]

VersionId

The document plugin’s version id that uniquely identifies one version of a document. If versioning is not supported, this will be blank. When versioning is supported, blank values imply the latest checked-in version.

public virtual string VersionId { get; set; }

Property Value

string

SuperOffice.WebApi.Data.VersionInfo

Class VersionInfo

Inheritance

Inherited Members

Constructors

VersionInfo()

Properties

CheckedInByAssociateId

Property Value

CheckedInByName

Property Value

CheckedInDate

Property Value

Description

Property Value

DisplayText

Property Value

DocumentId

Property Value

ExternalReference

Property Value

ExtraFields

Property Value

VersionId

Property Value

See Also

​ Class VersionInfo

​Inheritance

​Inherited Members

​Constructors

​ VersionInfo()

​Properties

​ CheckedInByAssociateId

​Property Value

​ CheckedInByName

​Property Value

​ CheckedInDate

​Property Value

​ Description

​Property Value

​ DisplayText

​Property Value

​ DocumentId

​Property Value

​ ExternalReference

​Property Value

​ ExtraFields

​Property Value

​ VersionId

​Property Value

​See Also

Class VersionInfo

Inheritance

Inherited Members

Constructors

VersionInfo()

Properties

CheckedInByAssociateId

Property Value

CheckedInByName

Property Value

CheckedInDate

Property Value

Description

Property Value

DisplayText

Property Value

DocumentId

Property Value

ExternalReference

Property Value

ExtraFields

Property Value

VersionId

Property Value

See Also