InAppBrowser.addEventListener Example

--- license: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --- InAppBrowser ============ > The `InAppBrowser` is a web browser that displays in the app when calling `window.open`. var ref = window.open('http://apache.org', '_blank', 'location=yes'); Description ----------- The object returned from a call to `window.open`. Methods ---------- - addEventListener - removeEventListener - close Permissions ----------- ### Android #### app/res/xml/config.xml ### iOS #### config.xml ### Windows Phone 7 + 8 #### config.xml addEventListener ================ > Adds a listener for an event from the `InAppBrowser`. ref.addEventListener(eventname, callback); - __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_ - __eventname__: the event to listen for _(String)_ - __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. - __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter. Supported Platforms ------------------- - Android - iOS - Windows Phone 7 + 8 Quick Example ------------- var ref = window.open('http://apache.org', '_blank', 'location=yes'); ref.addEventListener('loadstart', function() { alert(event.url); }); Full Example ------------ InAppBrowser.addEventListener Example removeEventListener =================== > Removes a listener for an event from the `InAppBrowser`. ref.removeEventListener(eventname, callback); - __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_ - __eventname__: the event to stop listening for. _(String)_ - __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 loading a URL. - __exit__: event fires when the `InAppBrowser` window is closed. - __callback__: the function to execute when the event fires. The function is passed an `InAppBrowserEvent` object. Supported Platforms ------------------- - Android - iOS - Windows Phone 7 + 8 Quick Example ------------- var ref = window.open('http://apache.org', '_blank', 'location=yes'); var myCallback = function() { alert(event.url); } ref.addEventListener('loadstart', myCallback); ref.removeEventListener('loadstart', myCallback); Full Example ------------ InAppBrowser.removeEventListener Example close ===== > Closes the `InAppBrowser` window. ref.close(); - __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_ Supported Platforms ------------------- - Android - iOS - Windows Phone 7 + 8 - BlackBerry 10 Quick Example ------------- var ref = window.open('http://apache.org', '_blank', 'location=yes'); ref.close(); Full Example ------------ InAppBrowser.close Example executeScript ============= > Injects JavaScript code into the `InAppBrowser` window ref.executeScript(details, callback); - __ref__: reference to the `InAppBrowser` window. _(InAppBrowser)_ - __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_ - __file__: URL of the script to inject. - __code__: Text of the script to inject. - __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. Supported Platforms ------------------- - Android - iOS Quick Example ------------- var ref = window.open('http://apache.org', '_blank', 'location=yes'); ref.addEventListener('loadstop', function() { ref.executeSript({file: "myscript.js"}); }); Full Example ------------ InAppBrowser.executeScript Example insertCSS ========= > Injects CSS into the `InAppBrowser` window. ref.insertCSS(details, callback); - __ref__: reference to the `InAppBrowser` window _(InAppBrowser)_ - __injectDetails__: details of the script to run, specifying either a `file` or `code` key. _(Object)_ - __file__: URL of the stylesheet to inject. - __code__: Text of the stylesheet to inject. - __callback__: the function that executes after the CSS is injected. Supported Platforms ------------------- - Android - iOS Quick Example ------------- var ref = window.open('http://apache.org', '_blank', 'location=yes'); ref.addEventListener('loadstop', function() { ref.insertCSS({file: "mystyles.css"}); }); Full Example ------------ InAppBrowser.executeScript Example InAppBrowserEvent ================= The object that is passed to the callback function from an `addEventListener` call on an `InAppBrowser` object. Properties ---------- - __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_ - __url__: the URL that was loaded. _(String)_ - __code__: the error code, only in the case of `loaderror`. _(Number)_ - __message__: the error message, only in the case of `loaderror`. _(String)_