NSReturnInfo - SuperOffice

Return value object for Document Plugin API calls.

Constructors

NSReturnInfo()

NSReturnInfo

Initializes a new instance of the NSReturnInfo class.

Methods

GetAdditionalInfo()

String GetAdditionalInfo()

Returns: CRMScript.Global.String - Optional, additional information meant for further processing.

This member is ignored for return types None, Message and SoProtocol. It can be used to pass execution-dependent information to the code that handles CustomGui and Other.

Example:

NSReturnInfo thing;
String additionalInfo = thing.GetAdditionalInfo();

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:

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

GetSuccess()

Bool GetSuccess()

Returns: CRMScript.Global.Bool - Did the call succeed. A successful call may still return a message or other return value. Example:

NSReturnInfo thing;
Bool success = thing.GetSuccess();

GetType()

Integer GetType()

Returns: CRMScript.Global.Integer - How is the return value to be understood by the caller. See <xref href=“CRMScript.NetServer.ReturnType” data-throw-if-not-resolved=“false”></xref>. Example:

NSReturnInfo thing;
Integer type = thing.GetType();

GetValue()

String GetValue()

Returns: CRMScript.Global.String - Return value, may be blank. Example:

NSReturnInfo thing;
String value = thing.GetValue();

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:

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

SetAdditionalInfo(String)

Void SetAdditionalInfo(String additionalInfo)

Returns: CRMScript.Global.Void

This member is ignored for return types None, Message and SoProtocol. It can be used to pass execution-dependent information to the code that handles CustomGui and Other.

Example:

NSReturnInfo thing;
String additionalInfo;
thing.SetAdditionalInfo(additionalInfo);

SetExternalReference(String)

Void SetExternalReference(String externalReference)

Returns: CRMScript.Global.Void

Stored in the externalReference field of the document table

Example:

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

SetSuccess(Bool)

Void SetSuccess(Bool success)

Returns: CRMScript.Global.Void Example:

NSReturnInfo thing;
Bool success;
thing.SetSuccess(success);

SetType(Integer)

Void SetType(Integer type)

Returns: CRMScript.Global.Void Example:

NSReturnInfo thing;
Integer type;
thing.SetType(type);

SetValue(String)

Void SetValue(String value)

Returns: CRMScript.Global.Void Example:

NSReturnInfo thing;
String value;
thing.SetValue(value);

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:

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

​Constructors

​NSReturnInfo()

​Methods

​GetAdditionalInfo()

​GetExternalReference()

​GetSuccess()

​GetType()

​GetValue()

​GetVersionId()

​SetAdditionalInfo(String)

​SetExternalReference(String)

​SetSuccess(Bool)

​SetType(Integer)

​SetValue(String)

​SetVersionId(String)

Constructors

NSReturnInfo()

Methods

GetAdditionalInfo()

GetExternalReference()

GetSuccess()

GetType()

GetValue()

GetVersionId()

SetAdditionalInfo(String)

SetExternalReference(String)

SetSuccess(Bool)

SetType(Integer)

SetValue(String)

SetVersionId(String)