Programmer API


Home>Product Description>Programmer API

 

The WebPublisher Studio API

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.

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


The following table lists all Public API methods available within WebPublisher Studio.
Clicking on the method name will load a description of the method selected.

Server API

File Methods

$ServerDir
$LogDir

 

 

Session Methods

$CreateSession
$VerifySession
$SessionActive
$CancelSessCode
$CancelSessUser
$ChangeSessUser

Mail Methods

$QueMail
$EvalMail

$SendMail

Client API

File Methods

$GetVersion
$SetHost
$GetHost
 

Communication Methods

$Request

Full descriptions of these methods and their use can be found in the WebPublisher Studio Manual available from the Purchasing page.

©Corporate Windows Pty Limited 2010