Class NSReturnInfo
Return value object for Document Plugin API calls.
Constructors
NSReturnInfo()
Initializes a new instance of the NSReturnInfo class.
Declaration
NSReturnInfoMethods
GetAdditionalInfo()
Declaration
String GetAdditionalInfo()Examples
NSReturnInfo thing;
String additionalInfo = thing.GetAdditionalInfo();Returns
| Type | Description |
| String | Optional, additional information meant for further processing. |
GetExternalReference()
Declaration
String GetExternalReference()Examples
NSReturnInfo thing;
String externalReference = thing.GetExternalReference();Returns
| Type | Description |
| String | The document plugin's key that uniquely identifies a document. |
GetSuccess()
Declaration
Bool GetSuccess()Examples
NSReturnInfo thing;
Bool success = thing.GetSuccess();Returns
| Type | Description |
| Bool | Did the call succeed. A successful call may still return a message or other return value. |
GetType()
Declaration
Integer GetType()Examples
NSReturnInfo thing;
Integer type = thing.GetType();Returns
| Type | Description |
| 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>. |
GetValue()
Declaration
String GetValue()Examples
NSReturnInfo thing;
String value = thing.GetValue();Returns
| Type | Description |
| String | Return value, may be blank. |
GetVersionId()
Declaration
String GetVersionId()Examples
NSReturnInfo thing;
String versionId = thing.GetVersionId();Returns
| Type | Description |
| String | The document plugin's version id that uniquely identifies one version of a document. |
SetAdditionalInfo(String)
Declaration
Void SetAdditionalInfo(String additionalInfo)Examples
NSReturnInfo thing;
String additionalInfo;
thing.SetAdditionalInfo(additionalInfo);Parameters
| Type | Name | Description |
| String | additionalInfo | Optional, additional information meant for further processing. |
Returns
| Type | Description |
| Void |
SetExternalReference(String)
Declaration
Void SetExternalReference(String externalReference)Examples
NSReturnInfo thing;
String externalReference;
thing.SetExternalReference(externalReference);Parameters
| Type | Name | Description |
| String | externalReference | The document plugin's key that uniquely identifies a document. |
Returns
| Type | Description |
| Void |
SetSuccess(Bool)
Declaration
Void SetSuccess(Bool success)Examples
NSReturnInfo thing;
Bool success;
thing.SetSuccess(success);Parameters
| Type | Name | Description |
| Bool | success | Did the call succeed. A successful call may still return a message or other return value. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSReturnInfo thing;
Integer type;
thing.SetType(type);Parameters
| Type | Name | Description |
| Integer | type | How is the return value to be understood by the caller See <xref href="CRMScript.NetServer.ReturnType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetValue(String)
Declaration
Void SetValue(String value)Examples
NSReturnInfo thing;
String value;
thing.SetValue(value);Parameters
| Type | Name | Description |
| String | value | Return value, may be blank. |
Returns
| Type | Description |
| Void |
SetVersionId(String)
Declaration
Void SetVersionId(String versionId)Examples
NSReturnInfo 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 |