Skip to main content

​
Class ReturnInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for ReturnInfo. Return value object for Document Plugin API calls

​
Inheritance

object ← ReturnInfo

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
ReturnInfo()

Default constructor - defaults any enum props to 0.

​
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.

​
Property Value

string

​
ExternalReference

The document plugin’s key that uniquely identifies a document; stored in the externalReference field of the document table

​
Property Value

string

​
Success

id the call succeed. A successful call may still return a message or other return value.

​
Property Value

bool

​
Type

How is the return value to be understood by the caller NULL if unknown enum value.

​
Property Value

ReturnType?

​
See Also

ReturnInfo.Type_String

​
Type_String

How is the return value to be understood by the caller Raw string enum value.

​
Property Value

string

​
See Also

ReturnInfo.Type

​
Value

Return value, may be blank.

​
Property Value

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.

​
Property Value

string

​
See Also

DocumentAgent

Related topics

WebAPI changes in SuperOffice 12.0SuperOffice WebApiWebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2How to use SuperOffice.WebApiHow to create a user-defined field using the web services APIHow to get all user-defined fields using the web services API