Class ReturnInfo
Return value object for Document Plugin API calls
Inherited Members
Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public sealed class ReturnInfoRemarks
Many document API calls return this object, which contains both information about which document it relates to, a result string value, and a result type that defines how this result should be parsed and processed by the caller.
See the ReturnType enum for more details and some caveats.
Constructors
ReturnInfo()
Declaration
public ReturnInfo()Properties
AdditionalInfo
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.
Declaration
public string AdditionalInfo { get; set; }Property Value
| Type | Description |
|---|---|
| String |
ExternalReference
The document plugin's key that uniquely identifies a document; stored in the externalReference field of the document table
Declaration
public string ExternalReference { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Success
Did the call succeed. A successful call may still return a message or other return value.
Declaration
public bool Success { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Type
How is the return value Value should be understood by the caller.
Declaration
public ReturnType Type { get; set; }Property Value
| Type | Description |
|---|---|
| ReturnType |
Value
Return value, may be blank. Interpretation depends on the Type property.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| String |
VersionId
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.
Declaration
public string VersionId { get; set; }Property Value
| Type | Description |
|---|---|
| String |