dff-cordova-plugin-common
Version:
404 lines (403 loc) • 18.1 kB
HTML
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_111) on Wed Mar 22 15:46:28 CET 2017 -->
<title>CommonServicePlugin</title>
<meta name="date" content="2017-03-22">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommonServicePlugin";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/dff/cordova/plugin/common/service/CommonServicePlugin.html" target="_top">Frames</a></li>
<li><a href="CommonServicePlugin.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.dff.cordova.plugin.common.service</div>
<h2 title="Class CommonServicePlugin" class="title">Class CommonServicePlugin</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cordova.CordovaPlugin</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">com.dff.cordova.plugin.common.CommonPlugin</a></li>
<li>
<ul class="inheritance">
<li>com.dff.cordova.plugin.common.service.CommonServicePlugin</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">CommonServicePlugin</span>
extends <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">CommonPlugin</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service">ServiceHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/dff/cordova/plugin/common/service/CommonServicePlugin.html#serviceHandler">serviceHandler</a></span></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.dff.cordova.plugin.common.CommonPlugin">
<!-- -->
</a>
<h3>Fields inherited from class com.dff.cordova.plugin.common.<a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">CommonPlugin</a></h3>
<code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#logListener">logListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.cordova.CordovaPlugin">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cordova.CordovaPlugin</h3>
<code>cordova, preferences, webView</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/dff/cordova/plugin/common/service/CommonServicePlugin.html#CommonServicePlugin-java.lang.String-">CommonServicePlugin</a></span>(java.lang.String TAG)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/dff/cordova/plugin/common/service/CommonServicePlugin.html#execute-java.lang.String-org.json.JSONArray-org.apache.cordova.CallbackContext-">execute</a></span>(java.lang.String action,
org.json.JSONArray args,
org.apache.cordova.CallbackContext callbackContext)</code>
<div class="block">Executes the request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/dff/cordova/plugin/common/service/CommonServicePlugin.html#onDestroy--">onDestroy</a></span>()</code>
<div class="block">The final call you receive before your activity is destroyed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/dff/cordova/plugin/common/service/CommonServicePlugin.html#pluginInitialize-com.dff.cordova.plugin.common.service.ServiceHandler-">pluginInitialize</a></span>(<a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service">ServiceHandler</a> serviceHandler)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.dff.cordova.plugin.common.CommonPlugin">
<!-- -->
</a>
<h3>Methods inherited from class com.dff.cordova.plugin.common.<a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">CommonPlugin</a></h3>
<code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onActivityResult-int-int-android.content.Intent-">onActivityResult</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onMessage-java.lang.String-java.lang.Object-">onMessage</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onNewIntent-android.content.Intent-">onNewIntent</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onPause-boolean-">onPause</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onReset--">onReset</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onRestoreStateForActivityResult-android.os.Bundle-org.apache.cordova.CallbackContext-">onRestoreStateForActivityResult</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onResume-boolean-">onResume</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onSaveInstanceState--">onSaveInstanceState</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onStart--">onStart</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onStop--">onStop</a>, <a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#pluginInitialize--">pluginInitialize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cordova.CordovaPlugin">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cordova.CordovaPlugin</h3>
<code>execute, execute, fromPluginUri, getServiceName, handleOpenForRead, hasPermisssion, initialize, onConfigurationChanged, onOverrideUrlLoading, onReceivedClientCertRequest, onReceivedHttpAuthRequest, onRequestPermissionResult, privateInitialize, remapUri, requestPermissions, shouldAllowBridgeAccess, shouldAllowNavigation, shouldAllowRequest, shouldOpenExternalUrl, toPluginUri</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="serviceHandler">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>serviceHandler</h4>
<pre>protected <a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service">ServiceHandler</a> serviceHandler</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CommonServicePlugin-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CommonServicePlugin</h4>
<pre>public CommonServicePlugin(java.lang.String TAG)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="pluginInitialize-com.dff.cordova.plugin.common.service.ServiceHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pluginInitialize</h4>
<pre>public void pluginInitialize(<a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service">ServiceHandler</a> serviceHandler)</pre>
</li>
</ul>
<a name="onDestroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDestroy</h4>
<pre>public void onDestroy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onDestroy--">CommonPlugin</a></code></span></div>
<div class="block">The final call you receive before your activity is destroyed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#onDestroy--">onDestroy</a></code> in class <code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">CommonPlugin</a></code></dd>
</dl>
</li>
</ul>
<a name="execute-java.lang.String-org.json.JSONArray-org.apache.cordova.CallbackContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>public boolean execute(java.lang.String action,
org.json.JSONArray args,
org.apache.cordova.CallbackContext callbackContext)
throws org.json.JSONException</pre>
<div class="block">Executes the request.
<p>
This method is called from the WebView thread. To do a non-trivial amount
of work, use: cordova.getThreadPool().execute(runnable);
<p>
To run on the UI thread, use:
cordova.getActivity().runOnUiThread(runnable);</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html#execute-java.lang.String-org.json.JSONArray-org.apache.cordova.CallbackContext-">execute</a></code> in class <code><a href="../../../../../../com/dff/cordova/plugin/common/CommonPlugin.html" title="class in com.dff.cordova.plugin.common">CommonPlugin</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>action</code> - The action to execute.</dd>
<dd><code>args</code> - The exec() arguments.</dd>
<dd><code>callbackContext</code> - The callback context used when calling back into JavaScript.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the action was valid.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.json.JSONException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../com/dff/cordova/plugin/common/service/ServiceHandler.html" title="class in com.dff.cordova.plugin.common.service"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/dff/cordova/plugin/common/service/CommonServicePlugin.html" target="_top">Frames</a></li>
<li><a href="CommonServicePlugin.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>