IPushPullApi

Provides run-time access to ipushpull Plugin

export interface

Methods

Method Details

addNewIPushPullPage

Adds a new page to ipushpull using given name in the supplied folder

addNewIPushPullPage(folder: string, page: string): void;

Parameters

Returns

void

getAutoLogin

Retrieves AutoLogin from ipushpull options; if true AdapTable will automatically log user in to ipushpull at start-up

getAutoLogin(): boolean;

Returns

boolean

getCurrentIPushPullPassword

Retrieves Password from ipushpull state -- AFTER someone logs in

getCurrentIPushPullPassword(): string | undefined;

Returns

string | undefined

getCurrentIPushPullUsername

Retrieves Username from ipushpull state - AFTER someone logs in

getCurrentIPushPullUsername(): string | undefined;

Returns

string | undefined

getCurrentLiveIPushPullReport

Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page

getCurrentLiveIPushPullReport(): IPushPullReport | undefined;

Returns

IPushPullReport | undefined

getFolderIdForName

Gets the Id of the ipushpull folder / Domain with the given name

getFolderIdForName(folderName: string): number;

Parameters

Returns

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

IPushPullDomain[]

getIPushPullInstance

Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state)

getIPushPullInstance(): any;

Returns

any

getIPushPullPassword

Retrieves Password from ipushpull options (if provided)

getIPushPullPassword(): string | undefined;

Returns

string | undefined

getIPushPullSchedules

Gets ipushpull schedules ie. reports set to run at particular times

getIPushPullSchedules(): IPushPullSchedule[];

Returns

IPushPullSchedule[]

getIPushPullThrottleTime

Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)

getIPushPullThrottleTime(): number | undefined;

Returns

number | undefined

getIPushPullUsername

Retrieves Username from ipushpull options (if provided)

getIPushPullUsername(): string | undefined;

Returns

string | undefined

getPagesForIPushPullDomain

Retrieves all pages in given ipushpull domain

getPagesForIPushPullDomain(domain: string): string[];

Parameters

Returns

string[]

includeSystemReports

Whether to display System Reports in ipushpull toolbar

includeSystemReports(): boolean;

Returns

boolean

isIPushPullAvailable

Checks if an ipushpull instance has been provided by the user

isIPushPullAvailable(): boolean | undefined;

Returns

boolean | undefined

isIPushPullLiveDataRunning

Checks if a report is sending Live Data to ipushpull

isIPushPullLiveDataRunning(): boolean | undefined;

Returns

boolean | undefined

isIPushPullReportLive

Checks if given report is currently 'live' (i.e. sending updates as data changes)

isIPushPullReportLive(report: IPushPullReport): boolean;

Parameters

Returns

boolean

isIPushPullRunning

Checks to see if ipushpull is running (i.e. a user has successfully logged in)

isIPushPullRunning(): boolean | undefined;

Returns

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

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

Returns

void

setIPushPullDomains

Sets given Domains as those for the current User

setIPushPullDomains(IPushPullDomains: IPushPullDomain[]): void;

Parameters

Returns

void

setIPushPullInstance

Sets the current ipushpull instance - this method should not generally be used.

setIPushPullInstance(ippInstance: any): void;

Parameters

Returns

void

setIPushPullThrottleTime

Sets Throttle time for ipushpull; how often a Live report will update ipushpull (if data changes)

setIPushPullThrottleTime(throttleTime: number): void;

Parameters

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

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