Difference between revisions of "Development:Prana Breath API"

From Olekdia Wiki
(Collections)
 
(33 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> - collection gives you access to all trainings on the device.<br/>
 
Aliases:
 
<code>trng</code>
 
  
=== 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, 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=%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'''
 
| 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.
 
  
|}
+
== Files ==
 +
* [[Development:Prana_Breath_API/Files:Trng|Training (.trng)]]
 +
* [[Development:Prana_Breath_API/Files:Snds|Sound style (.snds)]]
 +
 
 +
{{DISPLAYTITLE:<span style="position:absolute; top:-9999px;">Development:</span>Prana Breath API}}
 +
[[Category:Dev{{#translation:}}|^Prana Breath^]]

Latest revision as of 18:13, 1 February 2019

Prana Breath API allows to control the app using special queries as app links.

Collections

Files