awesome-cordova-plugins/src/plugins/inappbrowser.ts

import { Cordova, Plugin } from './plugin';


export interface InAppBrowserEvent extends Event {
  /** the eventname, either loadstart, loadstop, loaderror, or exit. */
  type: string;
  /** the URL that was loaded. */
  url: string;
  /** the error code, only in the case of loaderror. */
  code: number;
  /** the error message, only in the case of loaderror. */
  message: string;
}

export interface InAppBrowserRef {
  /**
   * Adds a listener for an event from the InAppBrowser.
   * @param type      the event to listen for
   *                  loadstart: event fires when the InAppBrowser starts to load a URL.
   *                  loadstop: event fires when the InAppBrowser finishes loading a URL.
   *                  loaderror: event fires when the InAppBrowser encounters an error when loading a URL.
   *                  exit: event fires when the InAppBrowser window is closed.
   * @param callback  the function that executes when the event fires. The function is
   *                  passed an InAppBrowserEvent object as a parameter.
   */
  addEventListener(type: string, callback: (event: InAppBrowserEvent) => void);

  /**
   * Removes a listener for an event from the InAppBrowser.
   * @param type      The event to stop listening for.
   *                  loadstart: event fires when the InAppBrowser starts to load a URL.
   *                  loadstop: event fires when the InAppBrowser finishes loading a URL.
   *                  loaderror: event fires when the InAppBrowser encounters an error when loading a URL.
   *                  exit: event fires when the InAppBrowser window is closed.
   * @param callback  the function that executes when the event fires. The function is
   *                  passed an InAppBrowserEvent object as a parameter.
   */
  removeEventListener(type: string, callback: (event: InAppBrowserEvent) => void);

  /** Closes the InAppBrowser window. */
  close();

  /**
   * Displays an InAppBrowser window that was opened hidden. Calling this has no effect
   * if the InAppBrowser was already visible.
   */
  show();

  /**
   * Injects JavaScript code into the InAppBrowser window.
   * @param script    Details of the script to run, specifying either a file or code key.
   * @param callback  The function that executes after the JavaScript code is injected.
   *                  If the injected script is of type code, the callback executes with
   *                  a single parameter, which is the return value of the script, wrapped in an Array.
   *                  For multi-line scripts, this is the return value of the last statement,
   *                  or the last expression evaluated.
   */
  executeScript(script: { file?: string, code?: string }, callback?: (result?: any) => void);

  /**
   * Injects CSS into the InAppBrowser window.
   * @param css       Details of the script to run, specifying either a file or code key.
   * @param callback  The function that executes after the CSS is injected.
   */
  insertCSS(css: { file?: string, code?: string }, callback?: () => void);
}

@Plugin({
  plugin: 'cordova-plugin-inappbrowser',
  pluginRef: 'cordova.InAppBrowser'
})
export class InAppBrowser {

  /**
   * Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.
   * @param  url     The URL to load.
   * @param  target  The target in which to load the URL, an optional parameter that defaults to _self.
   * @param  options Options for the InAppBrowser. Optional, defaulting to: location=yes.
   *                 The options string must not contain any blank space, and each feature's
   *                 name/value pairs must be separated by a comma. Feature names are case insensitive.
   */
  @Cordova({
    sync: true
  })
  static open(url: string, target?: string, options?: string): InAppBrowserRef { return; }

}