Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
Line 26: Line 26:
 
</pre>
 
</pre>
 
* <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> - It is a default command, so if we omit the command it will return the same result.
 +
|-
 +
| '''import'''
 +
| Import the specified training into the app.
 +
* <code>pranabreath://trainings/Sitkari?cmd=import</code> - Import [[Sitkari]] training.
 +
* <code>pranabreath://trainings?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training.
 +
* <code>pranabreath://trainings?cmd=import&json_data={"ENTRY":"TRAINING","name":"my_training","dur_time":480}</code> - Import the training which is a value of <code>json_data</code> parameter. The string which represents training should be encoded
 +
* <code>pranabreath://trainings?cmd=import&json_data=<wbr/>%7B%22ENTRY%22%3A%22TRAINING%22%2C%22name%22%3A%22my_training%22%2C%22dur_time%22%3A480%7D</code> - Same as above but training is represented by encoded string. It is mandatory to use with web link.
 
|-
 
|-
 
| '''start'''
 
| '''start'''
Line 33: Line 40:
 
* <code>pranabreath://trainings/2?cmd=start</code> - Training with id == 2 will be selected and started.
 
* <code>pranabreath://trainings/2?cmd=start</code> - Training with id == 2 will be selected and started.
 
* <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.
 
* <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.
|-
+
 
| '''import'''
 
| Import the specified training into the app.
 
* <code>pranabreath://trainings/Sitkari?cmd=import</code> - Import [[Sitkari]] training.
 
* <code>pranabreath://trainings?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training.
 
* <code>pranabreath://trainings?cmd=import&json_data=trainings?cmd=import&<wbr>json_data=%7B%22name%22%3A%22My_training%22%2C%22<wbr>trng_type%22%3A0%2C%22<wbr>dynamic_enabled%22%3A0%2C%7D</code> -
 
 
|}
 
|}

Revision as of 07:13, 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.
import Import the specified training into the app.
  • pranabreath://trainings/Sitkari?cmd=import - Import Sitkari training.
  • pranabreath://trainings?cmd=import&public_id=25 - Import training with public_id equals 25 which is Ha breathing training.
  • pranabreath://trainings?cmd=import&json_data={"ENTRY":"TRAINING","name":"my_training","dur_time":480} - Import the training which is a value of json_data parameter. The string which represents training should be encoded
  • pranabreath://trainings?cmd=import&json_data=%7B%22ENTRY%22%3A%22TRAINING%22%2C%22name%22%3A%22my_training%22%2C%22dur_time%22%3A480%7D - Same as above but training is represented by encoded string. It is mandatory to use with web link.
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.