Class NSVersionInfo
An instance of this class represents information about one version of one document.
Constructors
NSVersionInfo()
Initializes a new instance of the NSVersionInfo class.
Declaration
NSVersionInfoMethods
GetCheckedInByAssociateId()
Declaration
Integer GetCheckedInByAssociateId()Examples
NSVersionInfo thing;
Integer checkedInByAssociateId = thing.GetCheckedInByAssociateId();Returns
| Type | Description |
| Integer | Associate ID of the user who performed the check-in. |
GetCheckedInByName()
Declaration
String GetCheckedInByName()Examples
NSVersionInfo thing;
String checkedInByName = thing.GetCheckedInByName();Returns
| Type | Description |
| String | Name (nicely formatted) of the user/person who performed the check-in. |
GetCheckedInDate()
Declaration
DateTime GetCheckedInDate()Examples
NSVersionInfo thing;
DateTime checkedInDate = thing.GetCheckedInDate();Returns
| Type | Description |
| DateTime | The date that this version was checked in and became official. |
GetDescription()
Declaration
String GetDescription()Examples
NSVersionInfo thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Arbitrary description string. |
GetDisplayText()
Declaration
String GetDisplayText()Examples
NSVersionInfo thing;
String displayText = thing.GetDisplayText();Returns
| Type | Description |
| String | A short description, suitable for display in a popup menu or dropdown list of versions. |
GetDocumentId()
Declaration
Integer GetDocumentId()Examples
NSVersionInfo thing;
Integer documentId = thing.GetDocumentId();Returns
| Type | Description |
| Integer | The document ID that uniquely identifies the document within the SuperOffice database. |
GetExternalReference()
Declaration
String GetExternalReference()Examples
NSVersionInfo thing;
String externalReference = thing.GetExternalReference();Returns
| Type | Description |
| String | The document plugin's key that uniquely identifies a document; stored in the externalReference field of the document table. |
GetExtraFields()
Declaration
String[] GetExtraFields()Examples
NSVersionInfo thing;
String[] extraFields = thing.GetExtraFields();Returns
| Type | Description |
| String[] | Private metadata, owned by the document plugin. |
GetVersionId()
Declaration
String GetVersionId()Examples
NSVersionInfo thing;
String versionId = thing.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. |
SetCheckedInByAssociateId(Integer)
Declaration
Void SetCheckedInByAssociateId(Integer checkedInByAssociateId)Examples
NSVersionInfo thing;
Integer checkedInByAssociateId;
thing.SetCheckedInByAssociateId(checkedInByAssociateId);Parameters
| Type | Name | Description |
| Integer | checkedInByAssociateId | Associate ID of the user who performed the check-in. |
Returns
| Type | Description |
| Void |
SetCheckedInByName(String)
Declaration
Void SetCheckedInByName(String checkedInByName)Examples
NSVersionInfo thing;
String checkedInByName;
thing.SetCheckedInByName(checkedInByName);Parameters
| Type | Name | Description |
| String | checkedInByName | Name (nicely formatted) of the user/person who performed the check-in. |
Returns
| Type | Description |
| Void |
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)Examples
NSVersionInfo thing;
DateTime checkedInDate;
thing.SetCheckedInDate(checkedInDate);Parameters
| Type | Name | Description |
| DateTime | checkedInDate |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSVersionInfo thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Arbitrary description string. |
Returns
| Type | Description |
| Void |
SetDisplayText(String)
Declaration
Void SetDisplayText(String displayText)Examples
NSVersionInfo thing;
String displayText;
thing.SetDisplayText(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 |
SetDocumentId(Integer)
Declaration
Void SetDocumentId(Integer documentId)Examples
NSVersionInfo thing;
Integer documentId;
thing.SetDocumentId(documentId);Parameters
| Type | Name | Description |
| Integer | documentId | The document ID that uniquely identifies the document within the SuperOffice database. |
Returns
| Type | Description |
| Void |
SetExternalReference(String)
Declaration
Void SetExternalReference(String externalReference)Examples
NSVersionInfo thing;
String externalReference;
thing.SetExternalReference(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 |
SetExtraFields(String[])
Declaration
Void SetExtraFields(String[] extraFields)Examples
NSVersionInfo thing;
String[] extraFields;
thing.SetExtraFields(extraFields);Parameters
| Type | Name | Description |
| String[] | extraFields | Private metadata, owned by the document plugin. |
Returns
| Type | Description |
| Void |
SetVersionId(String)
Declaration
Void SetVersionId(String versionId)Examples
NSVersionInfo thing;
String versionId;
thing.SetVersionId(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 |