Glue42 API
Provides run-time access to the Glue42 Plugin.
Because Glue42 is available via a Plugin, the way to access the Api is as follows:
const glue42Api = adaptableApi.pluginsApi.getPluginApi('glue42');
caution
Some of the API methods are intended for internal use only - and have been marked as such.
Glue42 API Methods
| Method | Description |
|---|---|
| clearGlue42InternalState() | Clears all Gluee42 Internal State |
| getCurrentLiveGlue42Report() | Retrieves the current Live Report |
| getGlue42Schedules() | Retrieves all the Glue42 Schedules in from the Schedule section of AdapTable State |
| getGlue42State() | Retrieves the Glue42 section of Adaptable State |
| getPluginOptions() | Retrieves the Glue42PluginOptions provided in Glue42 Plugin |
| isGlue42Available() | Returns true if the Glue42 plugin is loaded |
| isGlue42Running() | Returns true if the Glue42 plugin is loaded AND the user has logged into Glue42 |
| loginToGlue42(userName, password) | Logs in the User to Glue42 using the given UserName and Password |
| logoutFromGlue42() | Logs out the currently logged in User from Glue42 |
| sendSnapshotToDo(glue42Report) | Starts a Snapshot as opposed to a Live report |
| setGlue42AvailableOff() | Sets Glue42 Availability Off |
| setGlue42AvailableOn() | Sets Glue42 Availability On |
| setGlue42LoginErrorMessage(loginErrorMessage) | Sets an Error Message returned from Glue42 if login fails |
| setGlue42RunningOff() | Sets Glue42 Running Off |
| setGlue42RunningOn() | Sets Glue42 Running On |
| showNotification(notification) | Shows a notification in Glue42 |
| showNotificationForAlert(alert) | Displays Alert as a Glue42 Notification |
| startLiveData(glue42Report) | Starts a "Live" report (ie. one which updates as the data ticks) |
| stopLiveData() | Stops a "Live" report (ie. one which updates as the data ticks) |