Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
(Created page with "== trainings == <code>trainings</code> - collection gives you access to all trainings the device.")
 
Line 1: Line 1:
 
== trainings ==
 
== trainings ==
<code>trainings</code> - collection gives you access to all trainings the device.
+
<code>trainings</code> - collection gives you access to all trainings on the device.<br/>
 +
Aliases:
 +
<code>trng</code>
 +
 
 +
=== Commands: ===
 +
{| class="wikitable" cellpadding="0" cellspacing="0" style="width: 100%;"
 +
|-
 +
! Command
 +
! Description
 +
|-
 +
| list
 +
| Returns training list. Currently it is only used in console for retrieving training list.
 +
''Input:'' <br/>
 +
<code>pranabreath://trainings?cmd=list</code><br/>
 +
''Result:'' <pre>
 +
pos id public_id name
 +
0  1  1        Clear mind
 +
1  2  2        Relax
 +
2  3  3        Calming
 +
3  4  4        Power
 +
4  5  5        Harmony
 +
5  6  6        Anti-stress
 +
6  7  7        Anti-appetite
 +
7  8  8        Cigarette replace
 +
8  9  11        Bhastrika
 +
</pre>
 +
It is a default command, so if we omit the command it will return the same result:<br/>
 +
<code>pranabreath://trainings</code>
 +
|-
 +
| start
 +
| Starts the selected training.
 +
''Input:''<br/>
 +
<code>pranabreath://trainings/Clear_mind?cmd=start</code><br/>
 +
''Result:''<br/>
 +
[[Clear mind]] training will be selected and started. Also it will bring the app to foreground with [[Training tab]] seleted.
 +
 
 +
|-
 +
|}

Revision as of 05:28, 31 January 2019

trainings

trainings - collection gives you access to all trainings on the device.
Aliases: trng

Commands:

Command Description
list Returns training list. Currently it is only used in console for retrieving training list.

Input:
pranabreath://trainings?cmd=list

Result:
pos id public_id name
0   1  1         Clear mind
1   2  2         Relax
2   3  3         Calming
3   4  4         Power
4   5  5         Harmony
5   6  6         Anti-stress
6   7  7         Anti-appetite
7   8  8         Cigarette replace
8   9  11        Bhastrika

It is a default command, so if we omit the command it will return the same result:
pranabreath://trainings

start Starts the selected training.

Input:
pranabreath://trainings/Clear_mind?cmd=start
Result:
Clear mind training will be selected and started. Also it will bring the app to foreground with Training tab seleted.