Window

Description: Window Service

Window management service. Manages the display of web apps within the system.

Load web app by appnameID

Method: POST

URL: _http://pmapi/window/pane?webapp=_**appnameID** Use the pm apps -w command to obtain the ID. The ID is displayed in the Channel column in the output.

$ pm apps -w
┌──────────┬──────────────────────────────┬──────────┬────────────────────────────────────────┐
│ Type     │ Name                         │ Version  │ Channel                                │
├──────────┼──────────────────────────────┼──────────┼────────────────────────────────────────┤
│ PM-APP   │ ContinuousLocation           │ 1.0      │ app-ContinuousLocation_1_0             │
│          │                              │          │                                        │
├──────────┼──────────────────────────────┼──────────┼────────────────────────────────────────┤
│ WEB-APP  │ continuouslocation-webapp    │ 0.0.1    │ webapp-continuouslocation-webapp_0_0_1 │
├──────────┼──────────────────────────────┼──────────┼────────────────────────────────────────┤
 

Load web app by appname

Method: POST

URL: _http://pmapi/window/pane?webapp=_**appname**

If using appname for the API call, your app.json file's dependencies must contain your web app name and version. For example:

  {
    "name": "FunctionalTestSuite",
    "version": "1.0.0",

    "starter": "e2e-app-test",
    "dependencies": {
        "e2e-app-test": "0.0.1",
        "webapp-pm-minimal-app": "0.0.1"
     }
}

Output: Standard HTTP status codes.

Extracts or updates appname webapp, from the local Couchbase database, and displays the appname webapp in the main view pane.

---

Show error dialog

Method: POST

URL: http://pmapi/window/showseriouserrorpage

Optional parameters:

• e=errorMessage : Displays errorMessage to user rather than default message.
• route=servicecall : After error dialog is dismissed, the service servicecall will be called instead of the default boot service.
• method=httpMethod : when used with webapp allows control of the HTTP Method used to call servicecall

Output: Standard HTTP status codes.

Used when an unrecoverable issue occurs. Displays the in-App "SeriousError" web page to the user, and restarts the boot service, or allows for the execution of another service call.

If the route or method parameters are included but blank the web app will not display the retry button.

If the e parameter is not included, a default message will be shown.

If for whatever reason the SeriousError page cannot be loaded, a native dialog box with similar functionality will be displayed.

Examples:

POST Request-> http://pmapi/window/showseriouserrorpage?e=A+truly+horrible%2C+unrecoverable+error+occurred

This will result in an alert dialog displaying the message "A truly horrible, unrecoverable error occurred". When the user taps the button, the system will re-initialize the boot service.

POST Request-> http://pmapi/window/showseriouserrorpage?e=An+error+occurred&route=window%2Fpane%3Fwebapp%3Dmyerrorapp&method=POST

This will result in an alert dialog displaying the message "An error occurred". When the user taps the button, the system will POST to the Window service to load the webapp "myerrorapp".

---

Native Spinner Control

Method: POST

URL: http://pmapi/window/spinner

Optional querystring parameters:

• state=on / off : Shows or hides the spinner. Defaults to "on" if this parameter is not included.
• msg=text_to_display : If included will show text_to_display below the spinner.

Output: Standard HTTP status codes.

Example:

POST Request-> http://pmapi/window/spinner?state=on&msg=Loading%20Data

---

Method: GET

URL: http://pmapi/window/spinner

Output:* Standard HTTP status codes, and JSON return data containing the current state:

Example:*

{
    "state" : "on"
    "msg" : "This is the display message"
}