Class NSVersionInfo

An instance of this class represents information about one version of one document.

Syntax

Constructors

NSVersionInfo()

Initializes a new instance of the NSVersionInfo class.

Declaration

NSVersionInfo

Methods

GetCheckedInByAssociateId()

An instance of this class represents information about one version of one document.

Declaration

Integer GetCheckedInByAssociateId()

Returns

Type	Description
Integer	Associate ID of the user who performed the check-in.

Examples

NSVersionInfo thing;
Integer checkedInByAssociateId = thing.GetCheckedInByAssociateId();

GetCheckedInByName()

An instance of this class represents information about one version of one document.

Declaration

String GetCheckedInByName()

Returns

Type	Description
String	Name (nicely formatted) of the user/person who performed the check-in.

Examples

NSVersionInfo thing;
String checkedInByName = thing.GetCheckedInByName();

GetCheckedInDate()

An instance of this class represents information about one version of one document.

Declaration

DateTime GetCheckedInDate()

Returns

Type	Description
DateTime	The date that this version was checked in and became official.

Examples

NSVersionInfo thing;
DateTime checkedInDate = thing.GetCheckedInDate();

GetDescription()

An instance of this class represents information about one version of one document.

Declaration

String GetDescription()

Returns

Type	Description
String	Arbitrary description string.

Examples

NSVersionInfo thing;
String description = thing.GetDescription();

GetDisplayText()

An instance of this class represents information about one version of one document.

Declaration

String GetDisplayText()

Returns

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

Examples

NSVersionInfo thing;
String displayText = thing.GetDisplayText();

GetDocumentId()

An instance of this class represents information about one version of one document.

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	The document ID that uniquely identifies the document within the SuperOffice database.

Examples

NSVersionInfo thing;
Integer documentId = thing.GetDocumentId();

GetExternalReference()

An instance of this class represents information about one version of one document.

Declaration

String GetExternalReference()

Returns

Type	Description
String	The document plugin's key that uniquely identifies a document; stored in the externalReference field of the document table.

Examples

NSVersionInfo thing;
String externalReference = thing.GetExternalReference();

GetExtraFields()

An instance of this class represents information about one version of one document.

Declaration

String[] GetExtraFields()

Returns

Type	Description
String[]	Private metadata, owned by the document plugin.

Remarks

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.

Examples

NSVersionInfo thing;
String[] extraFields = thing.GetExtraFields();

GetVersionId()

An instance of this class represents information about one version of one document.

Declaration

String GetVersionId()

Returns

Type	Description
String	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.

Examples

NSVersionInfo thing;
String versionId = thing.GetVersionId();

SetCheckedInByAssociateId(Integer)

An instance of this class represents information about one version of one document.

Declaration

Void SetCheckedInByAssociateId(Integer checkedInByAssociateId)

Parameters

Type	Name	Description
Integer	checkedInByAssociateId	Associate ID of the user who performed the check-in.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
Integer checkedInByAssociateId;
thing.SetCheckedInByAssociateId(checkedInByAssociateId);

SetCheckedInByName(String)

An instance of this class represents information about one version of one document.

Declaration

Void SetCheckedInByName(String checkedInByName)

Parameters

Type	Name	Description
String	checkedInByName	Name (nicely formatted) of the user/person who performed the check-in.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
String checkedInByName;
thing.SetCheckedInByName(checkedInByName);

SetCheckedInDate(DateTime)

Sets the date that this version was checked inThe date that this version was checked in and became official

Declaration

Void SetCheckedInDate(DateTime checkedInDate)

Parameters

Type	Name	Description
DateTime	checkedInDate

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
DateTime checkedInDate;
thing.SetCheckedInDate(checkedInDate);

SetDescription(String)

An instance of this class represents information about one version of one document.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Arbitrary description string.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
String description;
thing.SetDescription(description);

SetDisplayText(String)

An instance of this class represents information about one version of one document.

Declaration

Void SetDisplayText(String displayText)

Parameters

Type	Name	Description
String	displayText	A short description, suitable for display in a popup menu or dropdown list of versions.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
String displayText;
thing.SetDisplayText(displayText);

SetDocumentId(Integer)

An instance of this class represents information about one version of one document.

Declaration

Void SetDocumentId(Integer documentId)

Parameters

Type	Name	Description
Integer	documentId	The document ID that uniquely identifies the document within the SuperOffice database.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetExternalReference(String)

An instance of this class represents information about one version of one document.

Declaration

Void SetExternalReference(String externalReference)

Parameters

Type	Name	Description
String	externalReference	The document plugin's key that uniquely identifies a document; stored in the externalReference field of the document table.

Returns

Type	Description
Void

Examples

NSVersionInfo thing;
String externalReference;
thing.SetExternalReference(externalReference);

SetExtraFields(String[])

An instance of this class represents information about one version of one document.

Declaration

Void SetExtraFields(String[] extraFields)

Parameters

Type	Name	Description
String[]	extraFields	Private metadata, owned by the document plugin.

Returns

Type	Description
Void

Remarks

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

Examples

NSVersionInfo thing;
String[] extraFields;
thing.SetExtraFields(extraFields);

SetVersionId(String)

An instance of this class represents information about one version of one document.

Declaration

Void SetVersionId(String versionId)

Parameters

Type	Name	Description
String	versionId	The document plugin's version id that uniquely identifies one version of a document.

Returns

Type	Description
Void

Remarks

If versioning is not supported, this will be blank. When versioning is supported, blank values imply the latest checked-in version.

Examples

NSVersionInfo thing;
String versionId;
thing.SetVersionId(versionId);