|
|
| (16 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | == trainings ==
| + | Prana Breath API allows to control the app using special queries as [https://developer.android.com/training/app-links/ app links]. |
| − | <code>trainings</code>, or <code>trngs</code> - collection gives you access to all trainings in the app.<br/>
| |
| | | | |
| − | === Commands: === | + | == Collections == |
| − | {| class="wikitable long-code" cellpadding="0" cellspacing="0" style="width: 100%;"
| + | * [[Development:Prana_Breath_API/Collections:Trainings|Trainings]] |
| − | |-
| + | * [[Development:Prana_Breath_API/Collections:Tests|Tests]] |
| − | ! Command
| + | * [[Development:Prana_Breath_API/Collections:Reminders|Reminders]] |
| − | ! Description
| + | * [[Development:Prana_Breath_API/Collections:Motivators|Motivators]] |
| − | |-
| + | * [[Development:Prana_Breath_API/Collections:Settings|Settings]] |
| − | | '''list'''
| + | * [[Development:Prana_Breath_API/Collections:Views|Views]] |
| − | | Returns training list. Currently it is only used in console for retrieving training list.
| |
| − | * <code>pranabreath://trainings?cmd=list</code> | |
| − | <pre>
| |
| − | 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
| |
| − | </pre>
| |
| − | * <code>pranabreath://trainings</code> - It is a default command when only ''collection'' is defined without an ''item'', 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>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 [[Training_kind#Meditation|meditation]] with name "Serenity". | |
| − | * <code>pranabreath://trainings?cmd=create&name=4_7_8_Breathing&dur_prep_time=5000&trng_cycles={"mValues":[{"mInhaleUnit":4,"mRetainUnit":7,"mExhaleUnit":8,"mMethodsBitSet":129,"mSecPerUnit":1000}],"mKeys":[0,]}</code> - Create training with name "4_7_8_Breathing", with 5 seconds [[Preparing time|preparing time]], and 4:7:8:0 [[Ratio_of_breath_cycle|ratio]] | |
| − | |-
| |
| − | | '''start'''
| |
| − | | 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.
| |
| − | * <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/Some_custom_name?cmd=start</code> - If there is no "Some_custom_name" in the app - nothing happens.
| |
| − | * <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.
| |
| − | |-
| |
| − | | '''delete'''
| |
| − | | Delete the selected training. If there is no an entered training - nothing happens
| |
| − | |-
| |
| − | | '''info'''
| |
| − | |
| |
| − | |}
| |
| | | | |
| − | === Parameters: === | + | == Files == |
| − | {| class="wikitable long-code" cellpadding="0" cellspacing="0" style="width: 100%;"
| + | * [[Development:Prana_Breath_API/Files:Trng|Training (.trng)]] |
| − | |-
| + | * [[Development:Prana_Breath_API/Files:Snds|Sound style (.snds)]] |
| − | ! Parameter
| + | |
| − | ! Description
| + | {{DISPLAYTITLE:<span style="position:absolute; top:-9999px;">Development:</span>Prana Breath API}} |
| − | |-
| + | [[Category:Dev{{#translation:}}|^Prana Breath^]] |
| − | | '''name'''
| |
| − | | Name of the training.
| |
| − | * <code>pranabreath://trainings/Power?name=Energy</code> - Rename the "Power" training to "Energy". | |
| − | * <code>https://olekdia.com/pranabreath/Trainings/5?name=Balance</code> - Rename a training with equals 5, set name as "Balance".
| |
| − | |- | |
| − | | '''public_id'''
| |
| − | | Indicates public id of the training. All [[Training_type|trainings in this list]] have their own ''public_id''. Readonly value.
| |
| − | * <code>pranabreath://trngs?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training. | |
| − | |- | |
| − | | '''trng_type'''
| |
| − | | Is a [[Training_kind|kind]] of the training. Value range is [0 - [[Training_kind#Breathing_session|breathing session]], 1 - [[Training_kind#Meditation|meditation]]].
| |
| − | * <code>pranabreath://trainings?cmd=create&name=Serenity&trng_type=1</code> - Create [[Training_kind#Meditation|meditation]] with name "Serenity".
| |
| − | |-
| |
| − | | '''pos'''
| |
| − | | Position of the training in the training list.
| |
| − | * <code>pranabreath://trainings/Clear_mind?pos=9999</code> - Move the [[Clear mind]] training to the very bottom of the list.
| |
| − | |-
| |
| − | | '''curr_level'''
| |
| − | | Selected [[Complexity level|complexity level]] of a training (if applicable). Value range is [1, 5]
| |
| − | * <code>pranabreath://trngs/1?curr_level=3</code> - Set complexity level to "Advanced" for [[Clear_mind|clear mind training]]
| |
| − | |-
| |
| − | | '''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]
| |
| − | * <code>https://olekdia.com/pranabreath/Trainings/1?dur_time=480000</code> - Set [[Training duration|training duration]] to 480000 millis or 8 minutes for the training with id equals 1.
| |
| − | |-
| |
| − | | '''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]
| |
| − | * <code>pranabreath://trainings/Relax?dur_num_cycles=18</code> - Set [[Training duration|training duration]] to 18 cycles for the Relax training.
| |
| − | |-
| |
| − | | '''dur_prep_time'''
| |
| − | | [[Preparing time]] duration, in milliseconds. Value range is [0, 60000] | |
| − | * <code>https://olekdia.com/pranabreath/Trainings/Harmony?dur_prep_time=5000</code> - Set the preparing time to 5 seconds for the Harmony training.
| |
| − | |}
| |