NSVersionInfo - SuperOffice

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

Constructors

NSVersionInfo()

NSVersionInfo

Initializes a new instance of the NSVersionInfo class.

Methods

GetCheckedInByAssociateId()

Integer GetCheckedInByAssociateId()

Returns: CRMScript.Global.Integer - Associate ID of the user who performed the check-in. Example:

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

GetCheckedInByName()

String GetCheckedInByName()

Returns: CRMScript.Global.String - Name (nicely formatted) of the user/person who performed the check-in. Example:

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

GetCheckedInDate()

DateTime GetCheckedInDate()

Returns: CRMScript.Global.DateTime - The date that this version was checked in and became official. Example:

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

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - Arbitrary description string. Example:

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

GetDisplayText()

String GetDisplayText()

Returns: CRMScript.Global.String - A short description, suitable for display in a popup menu or dropdown list of versions. Example:

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

GetDocumentId()

Integer GetDocumentId()

Returns: CRMScript.Global.Integer - The document ID that uniquely identifies the document within the SuperOffice database. Example:

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

GetExternalReference()

String GetExternalReference()

Returns: CRMScript.Global.String - The document plugin’s key that uniquely identifies a document; stored in the externalReference field of the document table. Example:

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

GetExtraFields()

String[] GetExtraFields()

Returns: CRMScript.Global.String[] - 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.

Example:

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

GetVersionId()

String GetVersionId()

Returns: CRMScript.Global.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. Example:

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

SetCheckedInByAssociateId(Integer)

Void SetCheckedInByAssociateId(Integer checkedInByAssociateId)

Returns: CRMScript.Global.Void Example:

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

SetCheckedInByName(String)

Void SetCheckedInByName(String checkedInByName)

Returns: CRMScript.Global.Void Example:

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

Void SetCheckedInDate(DateTime checkedInDate)

Returns: CRMScript.Global.Void Example:

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

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetDisplayText(String)

Void SetDisplayText(String displayText)

Returns: CRMScript.Global.Void Example:

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

SetDocumentId(Integer)

Void SetDocumentId(Integer documentId)

Returns: CRMScript.Global.Void Example:

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

SetExternalReference(String)

Void SetExternalReference(String externalReference)

Returns: CRMScript.Global.Void Example:

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

SetExtraFields(String[])

Void SetExtraFields(String[] extraFields)

Returns: CRMScript.Global.Void

Example:

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

SetVersionId(String)

Void SetVersionId(String versionId)

Returns: CRMScript.Global.Void

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

Example:

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

​Constructors

​NSVersionInfo()

​Methods

​GetCheckedInByAssociateId()

​GetCheckedInByName()

​GetCheckedInDate()

​GetDescription()

​GetDisplayText()

​GetDocumentId()

​GetExternalReference()

​GetExtraFields()

​GetVersionId()

​SetCheckedInByAssociateId(Integer)

​SetCheckedInByName(String)

​SetCheckedInDate(DateTime)

​SetDescription(String)

​SetDisplayText(String)

​SetDocumentId(Integer)

​SetExternalReference(String)

​SetExtraFields(String[])

​SetVersionId(String)

Constructors

NSVersionInfo()

Methods

GetCheckedInByAssociateId()

GetCheckedInByName()

GetCheckedInDate()

GetDescription()

GetDisplayText()

GetDocumentId()

GetExternalReference()

GetExtraFields()

GetVersionId()

SetCheckedInByAssociateId(Integer)

SetCheckedInByName(String)

SetCheckedInDate(DateTime)

SetDescription(String)

SetDisplayText(String)

SetDocumentId(Integer)

SetExternalReference(String)

SetExtraFields(String[])

SetVersionId(String)