diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-06-23 14:12:10 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-06-23 14:12:10 +0200 |
| commit | bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b (patch) | |
| tree | 5fe76e243d94095bf2368122acb21db84a693aef /api/pl.treksoft.kvision.cordova/-geolocation | |
| parent | a8ff23c5e58394c21e2e7c2a4880302b43b60dfd (diff) | |
| download | kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.tar.gz kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.tar.bz2 kvision-bc2152266d0aa8b749d5202d54f9e7c4a5db5b5b.zip | |
API documentation for KVision 0.0.37
Diffstat (limited to 'api/pl.treksoft.kvision.cordova/-geolocation')
4 files changed, 126 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.cordova/-geolocation/clear-watch.html b/api/pl.treksoft.kvision.cordova/-geolocation/clear-watch.html new file mode 100644 index 00000000..3f2d9025 --- /dev/null +++ b/api/pl.treksoft.kvision.cordova/-geolocation/clear-watch.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Geolocation.clearWatch - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.cordova</a> / <a href="index.html">Geolocation</a> / <a href="./clear-watch.html">clearWatch</a><br/> +<br/> +<h1>clearWatch</h1> +<a name="pl.treksoft.kvision.cordova.Geolocation$clearWatch(kotlin.String)"></a> +<code><span class="keyword">fun </span><span class="identifier">clearWatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$clearWatch(kotlin.String)/watchId">watchId</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Clear the given watch.</p> +<h3>Parameters</h3> +<p><a name="watchId"></a> +<code>watchId</code> - watch identifier returned from <a href="watch-position.html">watchPosition</a> function</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.cordova/-geolocation/get-current-position.html b/api/pl.treksoft.kvision.cordova/-geolocation/get-current-position.html new file mode 100644 index 00000000..ba6e5040 --- /dev/null +++ b/api/pl.treksoft.kvision.cordova/-geolocation/get-current-position.html @@ -0,0 +1,22 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Geolocation.getCurrentPosition - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.cordova</a> / <a href="index.html">Geolocation</a> / <a href="./get-current-position.html">getCurrentPosition</a><br/> +<br/> +<h1>getCurrentPosition</h1> +<a name="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)"></a> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getCurrentPosition</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/enableHighAccuracy">enableHighAccuracy</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/timeout">timeout</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/maximumAge">maximumAge</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span> <a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">></span></code> +<p>Get current location.</p> +<h3>Parameters</h3> +<p><a name="enableHighAccuracy"></a> +<code>enableHighAccuracy</code> - provides a hint that the application needs the best possible results</p> +<p><a name="timeout"></a> +<code>timeout</code> - the maximum length of time (milliseconds) that is allowed to pass before getting the result</p> +<p><a name="maximumAge"></a> +<code>maximumAge</code> - accept a cached position whose age is no greater than the specified time in milliseconds</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.cordova/-geolocation/index.html b/api/pl.treksoft.kvision.cordova/-geolocation/index.html new file mode 100644 index 00000000..dce06dea --- /dev/null +++ b/api/pl.treksoft.kvision.cordova/-geolocation/index.html @@ -0,0 +1,60 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Geolocation - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.cordova</a> / <a href="./index.html">Geolocation</a><br/> +<br/> +<h1>Geolocation</h1> +<code><span class="keyword">object </span><span class="identifier">Geolocation</span></code> +<p>Main geolocation object based on webview api.</p> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="clear-watch.html">clearWatch</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">clearWatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$clearWatch(kotlin.String)/watchId">watchId</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Clear the given watch.</p> +</td> +</tr> +<tr> +<td> +<p><a href="get-current-position.html">getCurrentPosition</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getCurrentPosition</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/enableHighAccuracy">enableHighAccuracy</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/timeout">timeout</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number)/maximumAge">maximumAge</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span> <a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">></span></code> +<p>Get current location.</p> +</td> +</tr> +<tr> +<td> +<p><a href="watch-position.html">watchPosition</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">watchPosition</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/enableHighAccuracy">enableHighAccuracy</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/timeout">timeout</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/maximumAge">maximumAge</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/resultCallback">resultCallback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span> <a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>Watch location changes.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.cordova/-geolocation/watch-position.html b/api/pl.treksoft.kvision.cordova/-geolocation/watch-position.html new file mode 100644 index 00000000..31873a54 --- /dev/null +++ b/api/pl.treksoft.kvision.cordova/-geolocation/watch-position.html @@ -0,0 +1,26 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Geolocation.watchPosition - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.cordova</a> / <a href="index.html">Geolocation</a> / <a href="./watch-position.html">watchPosition</a><br/> +<br/> +<h1>watchPosition</h1> +<a name="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))"></a> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">watchPosition</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/enableHighAccuracy">enableHighAccuracy</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/timeout">timeout</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/maximumAge">maximumAge</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Geolocation$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/resultCallback">resultCallback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol"><</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span> <a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>Watch location changes.</p> +<h3>Parameters</h3> +<p><a name="enableHighAccuracy"></a> +<code>enableHighAccuracy</code> - provides a hint that the application needs the best possible results</p> +<p><a name="timeout"></a> +<code>timeout</code> - the maximum length of time (milliseconds) that is allowed to pass before getting the result</p> +<p><a name="maximumAge"></a> +<code>maximumAge</code> - accept a cached position whose age is no greater than the specified time in milliseconds</p> +<p><a name="resultCallback"></a> +<code>resultCallback</code> - a callback function receiving the result</p> +<p><strong>Return</strong><br/> +watch identifier (can be removed with a <a href="clear-watch.html">clearWatch</a> function)</p> +</BODY> +</HTML> |