Client server interface
The .
BlackBerry AtHoc
client server interface API (CSI) refers to the specification described in the AtHoc
Client Server Interface (CSI) Protocol - Technical SpecificationCSI includes Sign On (SO), Check Update (CU), Get Update (GU), and Get Service (GS).
The desktop app uses Microsoft’s WinInet API to communicate with the
BlackBerry AtHoc
server. The desktop app assembles a query string according to the CSI specification for the particular operation (SO, CU, GU, or GS) and appends it to the Base URL and passes that in the WinInet InternetConnect API call.The following are the three main channels for interaction between the desktop app and the
BlackBerry AtHoc
server:
- The back channel, with requests initiated from the desktop app communication daemon using XML over HTTP or HTTPS. This channel is used to query and retrieve configuration parameters from theBlackBerry AtHocserver to the desktop app. The configuration is organized in a series of configuration sections, covering the configurable look and feel of the desktop app. In order to make the communication between the desktop app and the server efficient, there is a versioning scheme that is used by both parties in order to ensure that the most updated configuration is passed to the desktop app, and that communication is limited to updated configuration sections only.
- The front channel, which is composed of web-based ActiveX methods (in Internet Explorer) that are used to trigger specific functions in the desktop app software from web pages. Such functions include setting the current user ID and triggering client-server configuration synchronization.
- The service channel, which is used on every service invocation from the desktop app. If the desktop app configuration is to redirect services through theBlackBerry AtHocserver, the invoked service will redirect the user to the final service destination URL.