Difference between revisions of "Development:Prana Breath API/Collections:Trainings"
From Olekdia Wiki
| Line 100: | Line 100: | ||
| '''custom_chants''' | | '''custom_chants''' | ||
| The [[Chants|custom chants]] of the training. | | The [[Chants|custom chants]] of the training. | ||
| − | * <code>pranabreath://trainings?cmd=create&name=Chanting_breathing&custom_chants=[" | + | * <code>pranabreath://trainings?cmd=create&name=Chanting_breathing&custom_chants=["Qm9vb20%3D","VmFhYW0%3D","UmFhYW0%3D"]&dynamic={"mValues":[{"mInhaleUnit":1,"mExhaleUnit":1,"mSustainUnit":2,"mChantsBitSet":1073742800,"mSecPerUnit":3000}],"mKeys":[0,]}</code> - Create the training with custom chants. Chants are passed as an array and also every chant is [https://en.wikipedia.org/wiki/Base64 Base64] encoded for the URL safety. |
|- | |- | ||
| '''note''' | | '''note''' | ||
| The [[Note|training note]]. | | The [[Note|training note]]. | ||
| − | * <code>pranabreath://trainings/Relax?note=VGhpcyB0cmFpbmluZyBpcyByZWFsbHkgaGVscGZ1bCBhZnRlciBsb25nIGNvbmNlbnRyYXRpb24%3D</code> - Set the training note for the [[Relax]] training. It will totally replace previous note if it existed. The note should be [https://en.wikipedia.org/wiki/Base64 Base64] encoded for the | + | * <code>pranabreath://trainings/Relax?note=VGhpcyB0cmFpbmluZyBpcyByZWFsbHkgaGVscGZ1bCBhZnRlciBsb25nIGNvbmNlbnRyYXRpb24%3D</code> - Set the training note for the [[Relax]] training. It will totally replace previous note if it existed. The note should be [https://en.wikipedia.org/wiki/Base64 Base64] encoded for the URL safety. |
|- | |- | ||
| '''json_data''' | | '''json_data''' | ||
Revision as of 15:52, 31 January 2019
trainings, or trngs - collection that gives you access to all trainings in the app.
Contents
Commands
| Command | Description |
|---|---|
| list | Returns training list. Currently it is only used in console for retrieving training 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
|
| import | Import the specified training into the app.
|
| create | Create the training with defined parameters. If training with such name already exists - new training will not be created. Instead all parameters will be applied to this training.
|
| 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.
|
| delete | Delete the selected training. If there is no an entered training - nothing happens |
| info |
Parameters
| Parameter | Description |
|---|---|
| name | Name of the training.
|
| public_id | Indicates public id of the training. All trainings in this list have their own public_id. Readonly value.
|
| trng_type | Is a kind of the training. Value range is [0 - breathing session, 1 - meditation].
|
| pos | Position of the training in the training list.
|
| curr_level | Selected complexity level of a training (if applicable). Value range is [1, 5]
|
| dur_time, or duration | Training duration, in milliseconds (if this value is set, training duration mode will be measured in amount of time). Value range is [1, 999]
|
| dur_num_cycles, or num_iterations | Training duration, in amount of cycles (if this value is set, training duration mode will be measured in amount of cycles). Value range is [1, 999]
|
| dur_prep_time | Preparing time duration, in milliseconds. Value range is [0, 60000]
|
| dynamic, or trng_cycles | The object which represents breathing or repose cycles of the training.
|
| dynamic_enabled | Trigger dynamic mode. Value range is [true, false].
|
| custom_chants | The custom chants of the training.
|
| note | The training note. |
| json_data | Data of training (.trng) file for importing.
|