ipushpull Technical Reference

Whether AdapTable should try log in to ipushpull automatically at start-up

The color theme to use when styling data pushed to ipushpull pages

Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown

The config required to run ipushpull; use your ipushpull credentials

The user's ipushpull password; if supplied, pre-populates the login screen's password textbox

How many miliseconds AdapTable should throttle when sending data updates to ipushpull

User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox

OAuth Client ID

OAuth Client Secret

Base URL for the ipushpull REST API

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

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

Retrieves Password from ipushpull state -- AFTER someone logs in

Retrieves Username from ipushpull state - AFTER someone logs in

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

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

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

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

Retrieves Password from ipushpull options (if provided)

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

Retrieves Username from ipushpull options (if provided)

Retrieves all pages in given ipushpull domain

Whether to display System Reports in ipushpull toolbar

Checks if an ipushpull instance has been provided by the user

Checks if a report is sending Live Data to ipushpull

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

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

Logins in user to ipushpull with given credentials; if successful ipushpull toolbar will display full set of controls

Logs out the current user from ipushpull (changes ipushpull toolbar to show Login button)

Publishes an ipushpull Report as a one-off export (i.e. with no live data)

Sets given Domains as those for the current User

Replaces the ipushpull instance AdapTable is using. Prefer the login methods.

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

Opens iPushPullPopup (though its currently empty!)

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

Pauses current Live Data report

When this happens the 'pause' button in the ipushpull toolbar changes back to a 'play' button