Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
Line 33: Line 33:
 
* <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={"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>https://olekdia.com/pranabreath/Trainings?cmd=import&json_data=%7B%22ENTRY%22%3A%22TRAINING%22%2C%22name%22%3A%22my_training%22%2C%22dur_time%22%3A480%2C%7D</code> - Same as above but training is represented by encoded string. It is mandatory to use with web link.
 
* <code>https://olekdia.com/pranabreath/Trainings?cmd=import&json_data=%7B%22ENTRY%22%3A%22TRAINING%22%2C%22name%22%3A%22my_training%22%2C%22dur_time%22%3A480%2C%7D</code> - Same as above but training is represented by encoded string. It is mandatory to use with web link.
 +
|-
 +
| '''create'''
 +
| Create the training with defined parameters.
 +
* <code>pranabreath://trainings?cmd=create&name=Serenity&trng_type=1</code> - Create [[meditation]] with name "Serenity".
 
|-
 
|-
 
| '''start'''
 
| '''start'''

Revision as of 08:08, 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.
create Create the training with defined parameters.
  • pranabreath://trainings?cmd=create&name=Serenity&trng_type=1 - Create meditation with name "Serenity".
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.