The WebPublisher Studio Application Programmer Interface (API) comprises a set of public class methods within WebPublisher Studio Server and WebPublisher Studio Client that are available to programmers developing WebPublisher Studio applications.
There are two types of API available to developers for web-enabling applications - the Server API and the Client API.
1. The Server API is part of the WebPublisher Studio Server application (WPServer.lbs) and can be requested whenever the server is installed and running. The WebPublisher server public API is contained in a group of API objects.
These are:
- The Server API object - methods for interacting with the server including SMTP mail and logging.
- The Session API object - methods for controlling user access and managing login sessions.
- The Request API object - methods for interrogating server request parameters.
- The Client API object - methods for initiating server requests from within WebPublisher Studio server.
These objects can be accessed from Omnis code blocks in Code Resources or from plugin library methods.
In the Macro environment, instances of the API objects are created and installed by the macro compiler and are accessed using the pre-defined object variable names: SERVER, SESSION, REQUEST and CLIENT.
To access an API object from a method in a plugin library class, instances of the API objects can be retrieved from the server with the following calls:
Do code method wpserver.api/$GetServerObj() Returns SERVER
Do code method wpserver.api/$GetSessionObj() Returns SESSION
Do code method wpserver.api/$GetRequestObj() Returns REQUEST
Do code method wpserver.api/$GetClientObj() Returns CLIENT
Some API methods require a reference to the calling plugin library to be passed as a parameter, $clib should be used for this purpose.
2. The Client API (WPXtools.lbs) is provided as an external plug-in component for the Thick Client Developer application (WPClient.lbs) and must be installed as an external library to enable the Thick Client communications layer.
Home
