Enum ReturnType

How should a return value from an API call or command be interpreted by the caller

Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public enum ReturnType
Remarks

Together with the ReturnInfo data class, this type opens the possibility for programming fairly complex workflows, with multiple roundtrips chained from one return to the next.

The disadvantage is that it places a responsibility on the author for choosing which clients to support, and to what extent - noting that the number of clients is always increasing, and that clients can have vastly different capabilities; from server-room sync processes that have no user interaction at all, to full-featured web or windows clients.

Fields

Name Description
CustomGui

3: The return value is the name of a custom GUI. The GetCustomGui method on the document plugin will be invoked, and the resulting GUI rendered.
Message

1: The return value is a string, to be shown to the user as a message. A modal dialog box for example.
None

0: There is no return value to be parsed.
Other

4: The return value is intended for custom processing; this implies that the document plugin has installed some component on the intended client that will intercept and handle this return value.
Note that this requires advanced knowledge of the client and its construction and navigation. Also note that this will make the functionality client-specific, so that it may not be available or work as intended on clients not specifically supported or known.
SoProtocol

2: SoProtocol. The return value is an soprotocol-compliant navigation string, to be parsed according to the rules for soprotocol strings. e.g. "contact.main?contact_id=123"
URL

5: The return value is a URL that should be opened in a new window.

Extension Methods

EnumUtil.MapEnums<SuperOffice.CRM.ReturnType, To>()