Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
Line 12: Line 12:
 
| '''list'''
 
| '''list'''
 
| Returns training list. Currently it is only used in console for retrieving training list.
 
| Returns training list. Currently it is only used in console for retrieving training list.
'''''Input:''''' <br/>
+
* <code>pranabreath://trainings?cmd=list</code>  
<code>pranabreath://trainings?cmd=list</code><br/>
+
<pre>
'''''Result:''''' <pre>
 
 
pos id public_id name
 
pos id public_id name
 
0  1  1        Clear mind
 
0  1  1        Clear mind
Line 26: Line 25:
 
8  9  11        Bhastrika
 
8  9  11        Bhastrika
 
</pre>
 
</pre>
It is a default command, so if we omit the command it will return the same result:<br/>
+
* <code>pranabreath://trainings</code> - It is a default command, so if we omit the command it will return the same result.
<code>pranabreath://trainings</code>
 
 
|-
 
|-
 
| '''start'''
 
| '''start'''
| Starts the selected training. If there is no the entered training - nothing happens, if only the training name is set from public [[Training_type|training list]], in such case it will be imported automatically and started.
+
| Starts the selected training. If there is no an entered training - nothing happens, if only the training name is set from public [[Training_type|training list]], in such case it will be imported automatically and started.
'''''Input:'''''<br/>
+
* <code>pranabreath://trainings/Clear_mind?cmd=start</code> - [[Clear mind]] training will be selected and started. Also it will bring the app to foreground with [[Training tab]] selected.  
<code>pranabreath://trainings/Clear_mind?cmd=start</code><br/>
+
* <code>pranabreath://trainings/Some_custom_name?cmd=start</code> - If there is no "Some_custom_name" in the app - nothing happens.
'''''Result:'''''<br/>
+
* <code>pranabreath://trainings/2?cmd=start</code> - Training with id == 2 will be selected and started.
[[Clear mind]] training will be selected and started. Also it will bring the app to foreground with [[Training tab]] selected.  
+
* <code>pranabreath://trainings/Bhastrika?cmd=start</code> - Training with name "Bhastrika" will be selected and started. If there is no such training [[Bhastrika]] training will be imported and started.
'''''Input:'''''<br/>
 
<code>pranabreath://trainings/Some_custom_name?cmd=start</code><br/>
 
'''''Result:'''''<br/>
 
If there is no "Some_custom_name" in the app - nothing happens.<br/>
 
<code>pranabreath://trainings/2?cmd=start</code><br/>
 
'''''Result:'''''<br/>
 
Training with id == 2 will be selected and started.
 
<code>pranabreath://trainings/Bhastrika?cmd=start</code><br/>
 
'''''Result:'''''<br/>
 
Training with name "Bhastrika" will be selected and started. Fi there is no such training [[Bhastrika]] training will be imported and started.
 
 
|-
 
|-
 
|}
 
|}

Revision as of 05:55, 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.
  • pranabreath://trainings?cmd=list
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
  • pranabreath://trainings - It is a default command, so if we omit the command it will return the same result.
start Starts the selected training. If there is no an entered training - nothing happens, if only the training name is set from public training list, in such case it will be imported automatically and started.
  • pranabreath://trainings/Clear_mind?cmd=start - Clear mind training will be selected and started. Also it will bring the app to foreground with Training tab selected.
  • pranabreath://trainings/Some_custom_name?cmd=start - If there is no "Some_custom_name" in the app - nothing happens.
  • pranabreath://trainings/2?cmd=start - Training with id == 2 will be selected and started.
  • pranabreath://trainings/Bhastrika?cmd=start - Training with name "Bhastrika" will be selected and started. If there is no such training Bhastrika training will be imported and started.