Public API reference


The Pega Client for Windows public API consists of interfaces and relevant methods. For a detailed description of individual objects and methods please follow the link below.

Management APIs

The management APIs include several interfaces and relevant methods for each, which enable management and monitoring of the lifecycle of both Pega Client for Windows and web applications, as well as management of user accounts.

Description Purpose
Authentication User authentication
Container Lifecycle Application management and monitoring
Logger Logging level configuration and access to local log files
User Accounts User account management
Web Application Lifecycle Various web application management objects and their methods.

Device integration APIs

Pega Client for Windows API includes a number of APIs that consist of several interfaces and relevant methods for each. This set of APIs allows developers to create applications that cooperate with existing functionalities of end-user devices.

Description Purpose
Document Picker Capturing of media and retrieving various documents from the gallery
Document Viewer Viewing of the content of external documents
Filesystem Access to the device's native file system
Geolocation Access to geolocation data, including latitude, longitude, altitude, accuracy, heading and speed

Helper APIs

These APIs include several interfaces and relevant methods for each, which allow developers to create solutions that utilize multiple web applications, or help overcome certain limitations.

Description Purpose
Interapp Communicator Sending events between applications

Pega Platform integration APIs

The following objects can be used in the Pega Client for Windows applications to enable Pega Platform integration.

Name Purpose
PRPC Client Store Enables performing data synchronization, as well as store and forward capabilities by means of the HTTPClientStore object and its methods.

Related topics

Setting up the API
Legal notice | Copyright © 2018 and Confidential to Pegasystems Inc. All rights reserved
Pega Community | Feedback
Advanced...