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

From Olekdia Wiki
(→‎Syntax)
(→‎name)
Line 57: Line 57:
 
|  
 
|  
 
==='''name'''===
 
==='''name'''===
−
| Name of the training.  
+
| Actually the message of the motivator.
−
* <code>pranabreath://trainings/Power?name=Energy</code> - Rename "Power" training to "Energy".
+
* <code>pranabreath://motivators/11?name=TWF5IHRoZSBGb3JjZSBiZSB3aXRoIHlvdSE=</code> - Set the message of the motivator with id equeals 11 to "May the Force be with you!". The message should be [https://en.wikipedia.org/wiki/Base64 Base64] encoded for the URL safety.
−
* <code>https://olekdia.com/pranabreath/Trainings/5?name=Balance</code> - Rename training with ID equals 5, set name as "Balance".
+
* <code>https://olekdia.com/pranabreath/motivators?cmd=create&name=TWF5IHRoZSBGb3JjZSBiZSB3aXRoIHlvdSE</code> - Todo.
 
|}
 
|}
 
</div>
 
</div>

Revision as of 17:11, 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://motivators/item?cmd=[Command] - Case-insensitive.
  • pranabreath://motivators/item?[Parameter]=[Value]
  • https://olekdia.com/pranabreath/motivators?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 motivator. If there is no selected motivator - nothing happens.
  • pranabreath://motivators/14?cmd=delete - Delete the motivator with id equals 14.

Parameters

Parameter Description

name

 Actually the message of the motivator.
Retrieved from "https://olekdia.com/index.php?title=Development:Prana_Breath_API/Collections:Motivators&oldid=84583"