title | description |
---|---|
allianz-teleconsultation |
Plugin that allows the use of Allianz teleconsultation service. |
You can show helpful articles, videos, and web resources inside of your app. Users can view web pages without leaving your app.
To get a few ideas, check out the sample at the bottom of this page or go straight to the reference content.
This plugin provides a web browser view that displays when calling cordova.InAppBrowser.open()
.
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
cordova plugin add cordova-plugin-allianz-teleconsultation
Opens a URL in a new InAppBrowser
instance, the current browser
instance, or the system browser.
var ref = cordova.InAppBrowser.open(url, target, options);
-
ref: Reference to the
InAppBrowser
window when the target is set to'_blank'
. (InAppBrowser) -
url: The URL to load (String). Call
encodeURI()
on this if the URL contains Unicode characters. -
target: The target in which to load the URL, an optional parameter that defaults to
_self
. (String)_self
: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in theInAppBrowser
._blank
: Opens in theInAppBrowser
._system
: Opens in the system's web browser.
-
options: Options for the
InAppBrowser
. Optional, defaulting to:location=yes
. (String)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.All platforms support:
- location: Set to
yes
orno
to turn theInAppBrowser
's location bar on or off.
Android supports these additional options:
- hidden: set to
yes
to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set tono
(default) to have the browser open and load normally. - beforeload: set to enable the
beforeload
event to modify which pages are actually loaded in the browser. Accepted values areget
to intercept only GET requests,post
to intercept on POST requests oryes
to intercept both GET & POST requests. Note that POST requests are not currently supported and will be ignored (if you setbeforeload=post
it will raise an error). - clearcache: set to
yes
to have the browser's cookie cache cleared before the new window is opened - clearsessioncache: set to
yes
to have the session cookie cache cleared before the new window is opened - closebuttoncaption: set to a string to use as the close button's caption instead of a X. Note that you need to localize this value yourself.
- closebuttoncolor: set to a valid hex color string, for example:
#00ff00
, and it will change the close button color from default, regardless of being a text or default X. Only has effect if user has location set toyes
. - footer: set to
yes
to show a close button in the footer similar to the iOS Done button. The close button will appear the same as for the header hence use closebuttoncaption and closebuttoncolor to set its properties. - footercolor: set to a valid hex color string, for example
#00ff00
or#CC00ff00
(#aarrggbb
) , and it will change the footer color from default. Only has effect if user has footer set toyes
. - hardwareback: set to
yes
to use the hardware back button to navigate backwards through theInAppBrowser
's history. If there is no previous page, theInAppBrowser
will close. The default value isyes
, so you must set it tono
if you want the back button to simply close the InAppBrowser. - hidenavigationbuttons: set to
yes
to hide the navigation buttons on the location toolbar, only has effect if user has location set toyes
. The default value isno
. - hideurlbar: set to
yes
to hide the url bar on the location toolbar, only has effect if user has location set toyes
. The default value isno
. - navigationbuttoncolor: set to a valid hex color string, for example:
#00ff00
, and it will change the color of both navigation buttons from default. Only has effect if user has location set toyes
and not hidenavigationbuttons set toyes
. - toolbarcolor: set to a valid hex color string, for example:
#00ff00
, and it will change the color the toolbar from default. Only has effect if user has location set toyes
. - lefttoright: Set to
yes
to swap positions of the navigation buttons and the close button. Specifically, navigation buttons go to the left and close button to the right. - zoom: set to
yes
to show Android browser's zoom controls, set tono
to hide them. Default value isyes
. - mediaPlaybackRequiresUserAction: Set to
yes
to prevent HTML5 audio or video from autoplaying (defaults tono
). - shouldPauseOnSuspend: Set to
yes
to make InAppBrowser WebView to pause/resume with the app to stop background audio (this may be required to avoid Google Play issues like described in CB-11013). - useWideViewPort: Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is
no
, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value isyes
and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used. (defaults toyes
).
iOS supports these additional options:
- hidden: set to
yes
to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set tono
(default) to have the browser open and load normally. - beforeload: set to enable the
beforeload
event to modify which pages are actually loaded in the browser. Accepted values areget
to intercept only GET requests,post
to intercept on POST requests oryes
to intercept both GET & POST requests. Note that POST requests are not currently supported and will be ignored (if you setbeforeload=post
it will raise an error). - clearcache: set to
yes
to have the browser's cookie cache cleared before the new window is opened - clearsessioncache: set to
yes
to have the session cookie cache cleared before the new window is opened. For WKWebView, requires iOS 11+ on target device. - cleardata: set to
yes
to have the browser's entire local storage cleared (cookies, HTML5 local storage, IndexedDB, etc.) before the new window is opened - closebuttoncolor: set as a valid hex color string, for example:
#00ff00
, to change from the default Done button's color. Only applicable if toolbar is not disabled. - closebuttoncaption: set to a string to use as the Done button's caption. Note that you need to localize this value yourself.
- disallowoverscroll: Set to
yes
orno
(default isno
). Turns on/off the UIWebViewBounce property. - hidenavigationbuttons: set to
yes
orno
to turn the toolbar navigation buttons on or off (defaults tono
). Only applicable if toolbar is not disabled. - navigationbuttoncolor: set as a valid hex color string, for example:
#00ff00
, to change from the default color. Only applicable if navigation buttons are visible. - toolbar: set to
yes
orno
to turn the toolbar on or off for the InAppBrowser (defaults toyes
) - toolbarcolor: set as a valid hex color string, for example:
#00ff00
, to change from the default color of the toolbar. Only applicable if toolbar is not disabled. - toolbartranslucent: set to
yes
orno
to make the toolbar translucent(semi-transparent) (defaults toyes
). Only applicable if toolbar is not disabled. - lefttoright: Set to
yes
to swap positions of the navigation buttons and the close button. Specifically, close button goes to the right and navigation buttons to the left. - enableViewportScale: Set to
yes
orno
to prevent viewport scaling through a meta tag (defaults tono
). Only applicable to UIWebView (usewkwebview=no
) and WKWebView (usewkwebview=yes
) on iOS 10+. - mediaPlaybackRequiresUserAction: Set to
yes
to prevent HTML5 audio or video from autoplaying (defaults tono
). Applicable to UIWebView (usewkwebview=no
) and WKWebView (usewkwebview=yes
). - allowInlineMediaPlayback: Set to
yes
orno
to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML'svideo
element must also include thewebkit-playsinline
attribute (defaults tono
). Applicable to UIWebView (usewkwebview=no
) and WKWebView (usewkwebview=yes
). - keyboardDisplayRequiresUserAction: Set to
yes
orno
to open the keyboard when form elements receive focus via JavaScript'sfocus()
call (defaults toyes
). Only applicable to UIWebView (usewkwebview=no
). - suppressesIncrementalRendering: Set to
yes
orno
to wait until all new view content is received before being rendered (defaults tono
). Only applicable to UIWebView (usewkwebview=no
). - presentationstyle: Set to
pagesheet
,formsheet
orfullscreen
to set the presentation style (defaults tofullscreen
). - transitionstyle: Set to
fliphorizontal
,crossdissolve
orcoververtical
to set the transition style (defaults tocoververtical
). - toolbarposition: Set to
top
orbottom
(default isbottom
). Causes the toolbar to be at the top or bottom of the window. - hidespinner: Set to
yes
orno
to change the visibility of the loading indicator (defaults tono
).
Windows supports these additional options:
- hidden: set to
yes
to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set tono
(default) to have the browser open and load normally. - hardwareback: works the same way as on Android platform.
- fullscreen: set to
yes
to create the browser control without a border around it. Please note that if location=no is also specified, there will be no control presented to user to close IAB window.
- location: Set to
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
var ref2 = cordova.AllianzTeleconsultation.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
The object returned from a call to cordova.AllianzTeleconsultation.open
when the target is set to '_blank'
.
- addEventListener
- removeEventListener
- close
- show
- hide
- executeScript
- insertCSS
Adds a listener for an event from the
InAppBrowser
. (Only available when the target is set to'_blank'
)
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. - beforeload: event fires when the
InAppBrowser
decides whether to load an URL or not (only with optionbeforeload
set). - message: event fires when the
InAppBrowser
receives a message posted from the page loaded inside theInAppBrowser
Webview.
- loadstart: event fires when the
-
callback: the function that executes when the event fires. The function is passed an
InAppBrowserEvent
object as a parameter.
var AllianzTeleconsultationRef;
function showHelp(url) {
var target = "_blank";
var options = "location=yes,hidden=yes,beforeload=yes";
AllianzTeleconsultationRef = cordova.AllianzTeleconsultation.open(url, target, options);
AllianzTeleconsultationRef.addEventListener('loadstart', loadStartCallBack);
AllianzTeleconsultationRef.addEventListener('loadstop', loadStopCallBack);
AllianzTeleconsultationRef.addEventListener('loaderror', loadErrorCallBack);
AllianzTeleconsultationRef.addEventListener('beforeload', beforeloadCallBack);
AllianzTeleconsultationRef.addEventListener('message', messageCallBack);
}
function loadStartCallBack() {
$('#status-message').text("loading please wait ...");
}
function loadStopCallBack() {
if (inAppBrowserRef != undefined) {
inAppBrowserRef.insertCSS({ code: "body{font-size: 25px;" });
inAppBrowserRef.executeScript({ code: "\
var message = 'this is the message';\
var messageObj = {my_message: message};\
var stringifiedMessageObj = JSON.stringify(messageObj);\
webkit.messageHandlers.cordova_iab.postMessage(stringifiedMessageObj);"
});
$('#status-message').text("");
inAppBrowserRef.show();
}
}
function loadErrorCallBack(params) {
$('#status-message').text("");
var scriptErrorMesssage =
"alert('Sorry we cannot open that page. Message from the server is : "
+ params.message + "');"
inAppBrowserRef.executeScript({ code: scriptErrorMesssage }, executeScriptCallBack);
inAppBrowserRef.close();
inAppBrowserRef = undefined;
}
function executeScriptCallBack(params) {
if (params[0] == null) {
$('#status-message').text(
"Sorry we couldn't open that page. Message from the server is : '"
+ params.message + "'");
}
}
function beforeloadCallBack(params, callback) {
if (params.url.startsWith("http://www.example.com/")) {
// Load this URL in the inAppBrowser.
callback(params.url);
} else {
// The callback is not invoked, so the page will not be loaded.
$('#status-message').text("This browser only opens pages on http://www.example.com/");
}
}
function messageCallBack(params){
$('#status-message').text("message received: "+params.data.my_message);
}
-
type: the eventname, either
loadstart
,loadstop
,loaderror
,message
orexit
. (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) -
data: the message contents , only in the case of
message
. A stringified JSON object. (String)
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstart', function(event) { alert(event.url); });
Removes a listener for an event from the
InAppBrowser
. (Only available when the target is set to'_blank'
)
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. - message: event fires when the
InAppBrowser
receives a message posted from the page loaded inside theInAppBrowser
Webview.
- loadstart: event fires when the
-
callback: the function to execute when the event fires. The function is passed an
InAppBrowserEvent
object.
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
var myCallback = function(event) { alert(event.url); }
ref.addEventListener('loadstart', myCallback);
ref.removeEventListener('loadstart', myCallback);
Closes the
InAppBrowser
window.
ref.close();
- ref: reference to the
InAppBrowser
window (InAppBrowser)
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
ref.close();
Displays an InAppBrowser window that was opened hidden. Calling this has no effect if the InAppBrowser was already visible.
ref.show();
- ref: reference to the InAppBrowser window (
InAppBrowser
)
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'hidden=yes');
// some time later...
ref.show();
Hides the InAppBrowser window. Calling this has no effect if the InAppBrowser was already hidden.
ref.hide();
- ref: reference to the InAppBrowser window (
InAppBrowser
)
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank');
// some time later...
ref.hide();
Injects JavaScript code into the
InAppBrowser
window. (Only available when the target is set to'_blank'
)
ref.executeScript(details, callback);
-
ref: reference to the
InAppBrowser
window. (InAppBrowser) -
injectDetails: details of the script to run, specifying either a
file
orcode
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 anArray
. For multi-line scripts, this is the return value of the last statement, or the last expression evaluated.
- If the injected script is of type
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
ref.executeScript({file: "myscript.js"});
});
Injects CSS into the
InAppBrowser
window. (Only available when the target is set to'_blank'
)
ref.insertCSS(details, callback);
-
ref: reference to the
InAppBrowser
window (InAppBrowser) -
injectDetails: details of the script to run, specifying either a
file
orcode
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.
- Android
- iOS
var ref = cordova.AllianzTeleconsultation.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
ref.insertCSS({file: "mystyles.css"});
});