Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
Line 30: Line 30:
 
|-
 
|-
 
| '''start'''
 
| '''start'''
| Starts the selected training.
+
| 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.
 
'''''Input:'''''<br/>
 
'''''Input:'''''<br/>
 
<code>pranabreath://trainings/Clear_mind?cmd=start</code><br/>
 
<code>pranabreath://trainings/Clear_mind?cmd=start</code><br/>
 
'''''Result:'''''<br/>
 
'''''Result:'''''<br/>
[[Clear mind]] training will be selected and started. Also it will bring the app to foreground with [[Training tab]] seleted.
+
[[Clear mind]] training will be selected and started. Also it will bring the app to foreground with [[Training tab]] selected.  
 
+
'''''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:50, 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 training list]], in such case it will be imported automatically and started.

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 selected. Input:
pranabreath://trainings/Some_custom_name?cmd=start
Result:
If there is no "Some_custom_name" in the app - nothing happens.
pranabreath://trainings/2?cmd=start
Result:
Training with id == 2 will be selected and started. pranabreath://trainings/Bhastrika?cmd=start
Result:
Training with name "Bhastrika" will be selected and started. Fi there is no such training Bhastrika training will be imported and started.