/** * Connection config for the ipushpull REST API. * * Only `api_key` and `api_secret` are required -- `api_url` defaults to the * ipushpull test environment (`https://test.ipushpull.com/api/1.0`). */ export interface IPushPullConfig { /** * Base URL for the ipushpull REST API * * @defaultValue 'https://test.ipushpull.com/api/1.0' */ api_url?: string; /** OAuth Client ID */ api_key: string; /** OAuth Client Secret */ api_secret: string; } /** * Options available in ipushpull plugin; allows users to collaborate and share data in powerful ways */ export interface IPushPullPluginOptions { /** * The config required to run ipushpull; use your ipushpull credentials */ ippConfig?: IPushPullConfig; /** * User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox */ username?: string; /** * The user's ipushpull password; if supplied, pre-populates the login screen's password textbox */ password?: string; /** * How many miliseconds AdapTable should throttle when sending data updates to ipushpull * * @defaultValue 2000 */ throttleTime?: number; /** * Whether AdapTable should try log in to ipushpull automatically at start-up * * @defaultValue false */ autoLogin?: boolean; /** * Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown * * @defaultValue true */ includeSystemReports?: boolean; /** * The color theme to use when styling data pushed to ipushpull pages * * @defaultValue derived from Adaptable's current theme (lightTheme or darkTheme) */ cellStyles?: 'lightTheme' | 'darkTheme'; }