aboutsummaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.cordova/-battery/index.html
blob: 1e9d1df81a89e594700b58af1d48ffd43c7c59d9 (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
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Battery - 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">Battery</a><br/>
<br/>
<h1>Battery</h1>
(js) <code><span class="keyword">object </span><span class="identifier">Battery</span></code>
<p>Main object for Cordova battery.</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
(js) 
<h4><a href="-battery-event/index.html">BatteryEvent</a></h4>
</td>
<td>
<p>Battery status event types.</p>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">BatteryEvent</span></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
(js) 
<h4><a href="add-status-listener.html">addStatusListener</a></h4>
</td>
<td>
<p>Add listeners for battery status Cordova events.</p>
<code><span class="keyword">fun </span><span class="identifier">addStatusListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.cordova.Battery$addStatusListener(pl.treksoft.kvision.cordova.Battery.BatteryEvent, kotlin.Function1((pl.treksoft.kvision.cordova.BatteryStatus, kotlin.Unit)))/event">event</span><span class="symbol">:</span>&nbsp;<span class="identifier">BatteryEvent</span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.cordova.Battery$addStatusListener(pl.treksoft.kvision.cordova.Battery.BatteryEvent, kotlin.Function1((pl.treksoft.kvision.cordova.BatteryStatus, kotlin.Unit)))/listener">listener</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><a href="../-battery-status/index.html"><span class="identifier">BatteryStatus</span></a><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/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
(js) 
<h4><a href="get-status.html">getStatus</a></h4>
</td>
<td>
<p>Get battery status.</p>
<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">getStatus</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-battery-status/index.html"><span class="identifier">BatteryStatus</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>