aboutsummaryrefslogtreecommitdiff
path: root/api1/pl.treksoft.kvision.cordova/-locationservices/index.html
blob: b432dfb8cba3693b9ab7c26679dafa36eecc4acf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Locationservices - kvision</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.cordova</a>&nbsp;/&nbsp;<a href="./index.html">Locationservices</a><br/>
<br/>
<h1>Locationservices</h1>
<code><span class="keyword">object </span><span class="identifier">Locationservices</span></code>
<p>Main geolocation object based on Google location services api.</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-priority/index.html">Priority</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">Priority</span></code>
<p>Location services priority.</p>
</td>
</tr>
</tbody>
</table>
<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.Locationservices$clearWatch(kotlin.String)/watchId">watchId</span><span class="symbol">:</span>&nbsp;<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.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/enableHighAccuracy">enableHighAccuracy</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/timeout">timeout</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/maximumAge">maximumAge</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/priority">priority</span><span class="symbol">:</span>&nbsp;<a href="-priority/index.html"><span class="identifier">Locationservices.Priority</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/interval">interval</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$getCurrentPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number)/fastInterval">fastInterval</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol">&lt;</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span>&nbsp;<a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">&gt;</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.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, 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>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, 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>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, 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>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/priority">priority</span><span class="symbol">:</span>&nbsp;<a href="-priority/index.html"><span class="identifier">Locationservices.Priority</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/interval">interval</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, kotlin.Number, kotlin.Number, kotlin.Function1((pl.treksoft.kvision.cordova.Result((pl.treksoft.kvision.cordova.Position, pl.treksoft.kvision.cordova.GeolocationException)), kotlin.Unit)))/fastInterval">fastInterval</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html"><span class="identifier">Number</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Locationservices$watchPosition(kotlin.Boolean, kotlin.Number, kotlin.Number, pl.treksoft.kvision.cordova.Locationservices.Priority, 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>&nbsp;<span class="symbol">(</span><a href="../-result/index.html"><span class="identifier">Result</span></a><span class="symbol">&lt;</span><a href="../-position/index.html"><span class="identifier">Position</span></a><span class="symbol">,</span>&nbsp;<a href="../-geolocation-exception/index.html"><span class="identifier">GeolocationException</span></a><span class="symbol">&gt;</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<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">&lt;</span><span class="identifier">T</span><span class="symbol">&gt;</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>&nbsp;<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>