Difference between revisions of "Development:Prana Breath API/Collections:Motivators"

From Olekdia Wiki
(Created page with "<code>motivators</code> - Collection that gives the control over motivators in the app.<br/> __TOC__ <div class="api-table long-code"> == Prefix == * <cod...")
 
Line 1: Line 1:
<code>motivators</code> - Collection that gives the control over [[Motivators_tab|motivators]] in the app.<br/>
+
<code>motivators</code> - Сollection that gives control over [[Motivators_tab|motivators]] in the app.<br/>
  
 
__TOC__
 
__TOC__
Line 24: Line 24:
 
==='''list'''===
 
==='''list'''===
 
| Returns training list. Currently it is used only in console for retrieving a training list.
 
| Returns training list. Currently it is used only in console for retrieving a training list.
* <code>pranabreath://trainings?cmd=list</code>  
+
* <code>pranabreath://motivators?cmd=list</code>  
 
<pre>
 
<pre>
pos id public_id name
+
id name
1        Clear mind
+
"Start from Monday" - is that familiar?
2        Relax
+
No more reasons to delay!
3        Calming
+
Find the time for your health!
4        Power
+
The work will still be there, so pause and breath!
5        Harmony
+
Remember, how's that - to breathe freely?
5  6  6        Anti-stress
+
It's time to invest in your health!
6   7 7        Anti-appetite
+
...
7  8  8        Cigarette replace
 
8  9  11        Bhastrika
 
 
</pre>
 
</pre>
* <code>pranabreath://trainings</code> - It is a default command if ''collection'' is defined without an ''item'', so if we omit the ''command'' it will return the same result.
+
* <code>pranabreath://motivators</code> - It is a default command if ''collection'' is defined without an ''item'', so if we omit the ''command'' it will return the same result.
 
|-
 
|-
 
|  
 
|  

Revision as of 16:35, 1 February 2019

motivators - Сollection that gives control over motivators in the app.

Prefix

  • pranabreath:// - Case-insensitive.
  • https://olekdia.com/pranabreath/ - Case-sensitive.
  • https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/ - Case-sensitive.

Syntax

  • pranabreath://trainings/item?cmd=[Command] - Case-insensitive.
  • pranabreath://Trainings/item?[Parameter]=[Value]
  • pranabreath://trainings/item?cmd=[Command]&[Parameter1]=[Value1]&[Parameter2]=[Value2]
  • https://olekdia.com/pranabreath/trainings?cmd=[Command]&[Parameter]=[Value] - Case-sensitive.

Commands

Command Description

list

Returns training list. Currently it is used only in console for retrieving a training list.
  • pranabreath://motivators?cmd=list
id name
1  "Start from Monday" - is that familiar?
2  No more reasons to delay!
3  Find the time for your health!
4  The work will still be there, so pause and breath!
5  Remember, how's that - to breathe freely?
6  It's time to invest in your health!
...
  • pranabreath://motivators - It is a default command if collection is defined without an item, so if we omit the command it will return the same result.

create

Create the training with certain parameters. If training with such name already exists - new training will not be created. Instead all parameters will be applied to existing training.
  • pranabreath://trainings?cmd=create&name=Serenity&trng_type=1 - Create meditation named "Serenity".
  • 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,]} - Create training named "4_7_8_Breathing", with 5 seconds preparing time, and 4:7:8:0 ratio.

delete

Delete the selected training. If there is no selected training - nothing happens.
  • pranabreath://trngs/14?cmd=delete - Delete the training with id equals 14.
  • pranabreath://trngs/Relax?cmd=delete - Delete Relax training.

Parameters

Parameter Description

name

Name of the training.