IPushPullApi
The ipushpull plugin: login, the current report, and sending a snapshot or live data.
export interfaceMethods
| 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 An IPushPullDomain contains 3 properties:- Name: the name of the Domain / Folder - FolderId: the number of the Domain / Folder - Pages: a string array containing the names of all the Pages in the Folder |
| 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 | Replaces the ipushpull instance AdapTable is using. Prefer the login methods. |
| 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 When this happens the 'play' button in the ipushpull toolbar changes to a red 'pause' button |
| stopLiveData() | void | Pauses current Live Data report When this happens the 'pause' button in the ipushpull toolbar changes back to a 'play' button |
Method Details
addNewIPushPullPage
Adds a new page to ipushpull using given name in the supplied folder
addNewIPushPullPage(folder: string, page: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| folder | string | the name of the folder where the page will be added |
| page | string | tbe name of the page to add |
Returns
void
getAutoLogin
Retrieves AutoLogin from ipushpull options; if true AdapTable will automatically log user in to ipushpull at start-up
getAutoLogin(): boolean;Returns
AutoLogin from ipushpull options; if true AdapTable will automatically log user in to ipushpull at start-up
boolean
getCurrentIPushPullPassword
Retrieves Password from ipushpull state -- AFTER someone logs in
getCurrentIPushPullPassword(): string | undefined;Returns
Password from ipushpull state -- AFTER someone logs in
string | undefined
getCurrentIPushPullUsername
Retrieves Username from ipushpull state - AFTER someone logs in
getCurrentIPushPullUsername(): string | undefined;Returns
Username from ipushpull state - AFTER someone logs in
string | undefined
getCurrentLiveIPushPullReport
Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page
getCurrentLiveIPushPullReport(): IPushPullReport | undefined;Returns
Current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page
IPushPullReport | undefined
getFolderIdForName
Gets the Id of the ipushpull folder / Domain with the given name
getFolderIdForName(folderName: string): number;Parameters
| Parameter | Type | Description |
|---|---|---|
| folderName | string | the ipushpull folder name |
Returns
The Id of the ipushpull folder / Domain with the given name
number
getIPushPullDomains
Retrieves all the ipushpull domain to which the current user has access
An IPushPullDomain contains 3 properties:
-
Name: the name of the Domain / Folder
-
FolderId: the number of the Domain / Folder
-
Pages: a string array containing the names of all the Pages in the Folder
getIPushPullDomains(): IPushPullDomain[];Returns
All the ipushpull domain to which the current user has access An IPushPullDomain contains 3 properties: - Name: the name of the Domain / Folder - FolderId: the number of the Domain / Folder - Pages: a string array containing the names of all the Pages in the Folder
getIPushPullInstance
Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state)
getIPushPullInstance(): any;Returns
The current ipushpull instance (if one has been provided by the User at design time in ipushpull state)
any
getIPushPullPassword
Retrieves Password from ipushpull options (if provided)
getIPushPullPassword(): string | undefined;Returns
Password from ipushpull options (if provided)
string | undefined
getIPushPullThrottleTime
Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)
getIPushPullThrottleTime(): number | undefined;Returns
Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)
number | undefined
getIPushPullUsername
Retrieves Username from ipushpull options (if provided)
getIPushPullUsername(): string | undefined;Returns
Username from ipushpull options (if provided)
string | undefined
getPagesForIPushPullDomain
Retrieves all pages in given ipushpull domain
getPagesForIPushPullDomain(domain: string): string[];Parameters
| Parameter | Type | Description |
|---|---|---|
| domain | string | ipushpull folder which contains the pages |
Returns
All pages in given ipushpull domain
string[]
includeSystemReports
Whether to display System Reports in ipushpull toolbar
includeSystemReports(): boolean;Returns
true when to display System Reports in ipushpull toolbar
boolean
isIPushPullAvailable
Checks if an ipushpull instance has been provided by the user
isIPushPullAvailable(): boolean | undefined;Returns
true when an ipushpull instance has been provided by the user
boolean | undefined
isIPushPullLiveDataRunning
Checks if a report is sending Live Data to ipushpull
isIPushPullLiveDataRunning(): boolean | undefined;Returns
true when a report is sending Live Data to ipushpull
boolean | undefined
isIPushPullReportLive
Checks if given report is currently 'live' (i.e. sending updates as data changes)
isIPushPullReportLive(report: IPushPullReport): boolean;Parameters
| Parameter | Type | Description |
|---|---|---|
| report | IPushPullReport | the report to check |
Returns
true when given report is currently 'live' (i.e. sending updates as data changes)
boolean
isIPushPullRunning
Checks to see if ipushpull is running (i.e. a user has successfully logged in)
isIPushPullRunning(): boolean | undefined;Returns
true when a user is logged in to ipushpull
boolean | undefined
loginToIPushPull
Logins in user to ipushpull with given credentials; if successful ipushpull toolbar will display full set of controls
loginToIPushPull(userName: string, password: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| userName | string | userName to send to ipushpull |
| password | string | password to send to ipushpull |
Returns
void
logoutFromIPushPull
Logs out the current user from ipushpull (changes ipushpull toolbar to show Login button)
logoutFromIPushPull(): void;Returns
void
sendSnapshot
Publishes an ipushpull Report as a one-off export (i.e. with no live data)
sendSnapshot(iPushPullReport: IPushPullReport): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| iPushPullReport | IPushPullReport | the report to publish |
Returns
void
setIPushPullDomains
Sets given Domains as those for the current User
setIPushPullDomains(IPushPullDomains: IPushPullDomain[]): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| IPushPullDomains | IPushPullDomain[] | the ipushpull Domains to set |
Returns
void
setIPushPullInstance
Replaces the ipushpull instance AdapTable is using. Prefer the login methods.
setIPushPullInstance(ippInstance: any): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| ippInstance | any | ipushpull instance to use |
Returns
void
setIPushPullThrottleTime
Sets Throttle time for ipushpull; how often a Live report will update ipushpull (if data changes)
setIPushPullThrottleTime(throttleTime: number): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| throttleTime | number | new throttle time to use |
Returns
void
showIPushPullPopup
Opens iPushPullPopup (though its currently empty!)
showIPushPullPopup(): void;Returns
void
startLiveData
Publishes ipushpull Report as Live Data; any changes to underlying data in report will be sent to ipushpull
When this happens the 'play' button in the ipushpull toolbar changes to a red 'pause' button
startLiveData(iPushPullReport: IPushPullReport): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| iPushPullReport | IPushPullReport | the report to publish |
Returns
void
stopLiveData
Pauses current Live Data report
When this happens the 'pause' button in the ipushpull toolbar changes back to a 'play' button
stopLiveData(): void;Returns
void