Skip to main content

# Application

API Defintion

## Methods​

Method | Encompass | Encompass Web | TPO | Consumer Connect | Notes
--- | --- | --- | --- | --- | ---
closeModal | ✖️ | ✔ | ✖️ | ✖️ |
getApplicationContext | ✖️ | ✔ | ✖️ | ✖️ |
getCapabilities | ✖️ | ✔ | ✖️ | ✖️ |
getCompanySettings | ✖️ | ✖️ | ✖️ | ✖️ |
getDescriptor | ✖️ | ○ | ✖️ | ✖️ | Encompass Web - Name change is required from getDescriptior to getDescriptor
getInfo | ✖️ | ✖️ | ✖️ | ✖️ |
getPersonaAccess | ✖️ | ○ | ✖️ | ✖️ |
getPoliciesDetails | ✖️ | ✔ | ✖️ | ✖️ |
getUserAccessRights | ✖️ | ✔ | ✖️ | ✖️ |
keepSessionAlive | ✖️ | ✔ | ✖️ | ✖️ |
navigate | ✖️ | ✔ | ✖️ | ✖️ |
open | ✖️ | ✖️ | ✖️ | ✖️ |
openModal | ✖️ | ○ | ✖️ | ✖️ | Encompass Web - <br />PUI scripting object, value for target is of type string i.e. { name: string; size: ModalSize; target: string; type?: string }<br />EncompassWeb - target value can be of type string or object
performAction | ✖️ | ○ | ✖️ | ✖️ | Encompass Web - This method has been implemented but it will not perform any action, as supportedAction array is empty
print | ✖️ | ✔ | ✖️ | ✖️ |
supportsAction | ✖️ | ✖️ | ✖️ | ✖️ |

## Events​

Event | Encompass | Encompass Web | TPO | Consumer Connect | Notes
--- | --- | --- | --- | --- | ---
Actioncompleted | ✖️ | ✖️ | ✖️ | ✖️ |
Login | ✖️ | ✔ | ✖️ | ✖️ |
NavigationStart | ✖️ | ✔ | ✖️ | ✖️ | Fire-and-receive-feedback event. Return true to allow navigation, false to cancel