Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

documenting the custom schemes handling #357

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

documenting the custom schemes handling #357

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29e753a
customscheme and AllowedSchemes docs
boynet Nov 28, 2018
bac3dc1
typo
janpio Nov 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,17 @@ The object returned from a call to `cordova.InAppBrowser.open` when the target i
- __loaderror__: event fires when the `InAppBrowser` encounters an error when loading a URL.
- __exit__: event fires when the `InAppBrowser` window is closed.
- __beforeload__: event fires when the `InAppBrowser` decides whether to load an URL or not (only with option `beforeload=yes`).

- __customscheme__: event fires when the `InAppBrowser` load an custom schemes (Only when approved in AllowedSchemes preference).

- __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter.

### Preferences

- __AllowedSchemes__ (string, defaults to null). Configure the allowable schemes in a comma separated list in a new preference. This implements whitelisting for the allowed schemes, but doesn't use the Cordova Whitelist plugin.
to make your customscheme event to fire on this urls: `examplescheme://` and `othercheme://` add:

<preference name="AllowedSchemes" value="examplescheme,othercheme" />

## Example

```javascript
Expand All @@ -238,6 +246,8 @@ function showHelp(url) {

inAppBrowserRef.addEventListener('beforeload', beforeloadCallBack);

inAppBrowserRef.addEventListener('customscheme', customschemeCallBack);

}

function loadStartCallBack() {
Expand Down Expand Up @@ -300,11 +310,17 @@ function beforeloadCallback(params, callback) {

}

function customschemeCallBack(event) {

$('#status-message').text("An approved custome scheme url loaded, url:" + event.url);
boynet marked this conversation as resolved.
Show resolved Hide resolved

}

```

### InAppBrowserEvent Properties

- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, `customscheme`, or `exit`. _(String)_

- __url__: the URL that was loaded. _(String)_

Expand Down Expand Up @@ -344,6 +360,7 @@ function beforeloadCallback(params, callback) {
- __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.
- __customscheme__: event fires when the `InAppBrowser` load an custom schemes (Only when approved in AllowedSchemes preference).

- __callback__: the function to execute when the event fires.
The function is passed an `InAppBrowserEvent` object.
Expand Down