ipushpull Technical Reference
Summary
- ipushpull Plugin Options helps to configure ipushpull at design-time
- ipushpull API provides run-time access to ipushpull
ipushpull Plugin Options
Options for managing the ipushpull Plugin:
| Property | Type | Description | Default |
|---|---|---|---|
| autoLogin | boolean | Whether AdapTable should try log in to ipushpull automatically at start-up | false |
| cellStyles | 'lightTheme' | 'darkTheme' | The color theme to use when styling data pushed to ipushpull pages | derived from Adaptable's current theme (lightTheme or darkTheme) |
| includeSystemReports | boolean | Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown | true |
| ippConfig | IPushPullConfig | The config required to run ipushpull; use your ipushpull credentials | |
| password | string | The user's ipushpull password; if supplied, pre-populates the login screen's password textbox | |
| throttleTime | number | How many miliseconds AdapTable should throttle when sending data updates to ipushpull | 2000 |
| username | string | User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox |
ipushpull API
The ipushpull API section of AdapTable contains many functions for run-time access to the ipushull integration:
| Method | Returns | Description |
|---|---|---|
| addNewIPushPullPage(folder, page) | void | Adds a new page to ipushpull using given name in the supplied folder |
| getAutoLogin() | boolean | Retrieves AutoLogin from ipushpull options; if true AdapTable will automatically log user in to ipushpull at start-up |
| getCurrentIPushPullPassword() | string | undefined | Retrieves Password from ipushpull state -- AFTER someone logs in |
| getCurrentIPushPullUsername() | string | undefined | Retrieves Username from ipushpull state - AFTER someone logs in |
| getCurrentLiveIPushPullReport() | IPushPullReport | undefined | Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page |
| getFolderIdForName(folderName) | number | Gets the Id of the ipushpull folder / Domain with the given name |
| getIPushPullDomains() | IPushPullDomain[] | Retrieves all the ipushpull domain to which the current user has access |
| getIPushPullInstance() | any | Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state) |
| getIPushPullPassword() | string | undefined | Retrieves Password from ipushpull options (if provided) |
| getIPushPullThrottleTime() | number | undefined | Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes) |
| getIPushPullUsername() | string | undefined | Retrieves Username from ipushpull options (if provided) |
| getPagesForIPushPullDomain(domain) | string[] | Retrieves all pages in given ipushpull domain |
| includeSystemReports() | boolean | Whether to display System Reports in ipushpull toolbar |
| isIPushPullAvailable() | boolean | undefined | Checks if an ipushpull instance has been provided by the user |
| isIPushPullLiveDataRunning() | boolean | undefined | Checks if a report is sending Live Data to ipushpull |
| isIPushPullReportLive(report) | boolean | Checks if given report is currently 'live' (i.e. sending updates as data changes) |
| isIPushPullRunning() | boolean | undefined | Checks to see if ipushpull is running (i.e. a user has successfully logged in) |
| loginToIPushPull(userName, password) | void | Logins in user to ipushpull with given credentials; if successful ipushpull toolbar will display full set of controls |
| logoutFromIPushPull() | void | Logs out the current user from ipushpull (changes ipushpull toolbar to show Login button) |
| sendSnapshot(iPushPullReport) | void | Publishes an ipushpull Report as a one-off export (i.e. with no live data) |
| setIPushPullDomains(IPushPullDomains) | void | Sets given Domains as those for the current User |
| setIPushPullInstance(ippInstance) | void | Sets the current ipushpull instance - this method should not generally be used. |
| setIPushPullThrottleTime(throttleTime) | void | Sets Throttle time for ipushpull; how often a Live report will update ipushpull (if data changes) |
| showIPushPullPopup() | void | Opens iPushPullPopup (though its currently empty!) |
| startLiveData(iPushPullReport) | void | Publishes ipushpull Report as Live Data; any changes to underlying data in report will be sent to ipushpull |
| stopLiveData() | void | Pauses current Live Data report |
Accessing API
Because ipushpull is available via a Plugin, the easiest way to access the Api is as follows:
const ipushpullApi = adaptableApi.pluginsApi.getipushpullPluginApi();