You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by an...@apache.org on 2017/01/20 08:43:59 UTC
cordova-plugin-inappbrowser git commit: CB-12369: Add plugin typings
from DefinitelyTyped
Repository: cordova-plugin-inappbrowser
Updated Branches:
refs/heads/master 6671608a3 -> 771bcb54c
CB-12369: Add plugin typings from DefinitelyTyped
This closes #211
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/commit/771bcb54
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/tree/771bcb54
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/diff/771bcb54
Branch: refs/heads/master
Commit: 771bcb54cf5760ff8c50b6874584ab9ba33238dc
Parents: 6671608
Author: Nikita Matrosov <v-...@microsoft.com>
Authored: Thu Jan 19 16:09:11 2017 +0300
Committer: Vladimir Kotikov <ko...@gmail.com>
Committed: Fri Jan 20 11:43:44 2017 +0300
----------------------------------------------------------------------
package.json | 1 +
types/index.d.ts | 219 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 220 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/blob/771bcb54/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 915a81e..bd3355a 100644
--- a/package.json
+++ b/package.json
@@ -2,6 +2,7 @@
"name": "cordova-plugin-inappbrowser",
"version": "1.6.2-dev",
"description": "Cordova InAppBrowser Plugin",
+ "types": "./types/index.d.ts",
"cordova": {
"id": "cordova-plugin-inappbrowser",
"platforms": [
http://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser/blob/771bcb54/types/index.d.ts
----------------------------------------------------------------------
diff --git a/types/index.d.ts b/types/index.d.ts
new file mode 100644
index 0000000..d5e221b
--- /dev/null
+++ b/types/index.d.ts
@@ -0,0 +1,219 @@
+// Type definitions for Apache Cordova InAppBrowser plugin
+// Project: https://github.com/apache/cordova-plugin-inappbrowser
+// Definitions by: Microsoft Open Technologies Inc <http://msopentech.com>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+//
+// Copyright (c) Microsoft Open Technologies Inc
+// Licensed under the MIT license.
+
+interface Window {
+ /**
+ * 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.
+ */
+ open(url: string, target?: "_self", options?: string): 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.
+ */
+ open(url: string, target?: "_blank", options?: string): 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.
+ */
+ open(url: string, target?: "_system", options?: string): 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.
+ */
+ open(url: string, target?: string, options?: string, replace?: boolean): InAppBrowser;
+}
+
+/**
+ * The object returned from a call to window.open.
+ * NOTE: The InAppBrowser window behaves like a standard web browser, and can't access Cordova APIs.
+ */
+interface InAppBrowser extends Window {
+ onloadstart: (type: InAppBrowserEvent) => void;
+ onloadstop: (type: InAppBrowserEvent) => void;
+ onloaderror: (type: InAppBrowserEvent) => void;
+ onexit: (type: InAppBrowserEvent) => void;
+ // addEventListener overloads
+ /**
+ * 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: "loadstart", callback: (event: InAppBrowserEvent) => void): void;
+ /**
+ * 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: "loadstop", callback: (event: InAppBrowserEvent) => void): void;
+ /**
+ * 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: "loaderror", callback: (event: InAppBrowserEvent) => void): void;
+ /**
+ * 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: "exit", callback: (event: InAppBrowserEvent) => void): void;
+ /**
+ * 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 Event object as a parameter.
+ */
+ addEventListener(type: string, callback: (event: Event) => void): void;
+ // removeEventListener overloads
+ /**
+ * 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: "loadstart", callback: (event: InAppBrowserEvent) => void): 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: "loadstop", callback: (event: InAppBrowserEvent) => void): 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: "loaderror", callback: (event: InAppBrowserEvent) => void): 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: "exit", callback: (event: InAppBrowserEvent) => void): 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 Event object as a parameter.
+ */
+ removeEventListener(type: string, callback: (event: Event) => void): void;
+ /** Closes the InAppBrowser window. */
+ close(): void;
+ /**
+ * Displays an InAppBrowser window that was opened hidden. Calling this has no effect
+ * if the InAppBrowser was already visible.
+ */
+ show(): void;
+ /**
+ * 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: { code: string }, callback: (result: any) => void): void;
+ /**
+ * 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 }, callback: (result: any) => void): 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: { code: string }, callback: () => void): 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 }, callback: () => void): void;
+}
+
+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;
+}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org