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

From Olekdia Wiki
(Created page with "<code>reminders</code>, or <code>rems</code> - collection that gives you control over reminders in the app.<br/> __TOC__ <div class="api-table long-code"> == Prefix == * <co...")
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<code>reminders</code>, or <code>rems</code> - collection that gives you control over reminders in the app.<br/>
+
<code>reminders</code>, or <code>rems</code> - Сollection that gives control over app's [[Reminders_tab|reminders]].<br/>
  
 
__TOC__
 
__TOC__
Line 6: Line 6:
 
== Prefix ==
 
== Prefix ==
 
* <code>pranabreath://</code> - Case-insensitive.  
 
* <code>pranabreath://</code> - Case-insensitive.  
−
* <code><nowiki>https://olekdia.com/pranabreath/</nowiki></code> - Case-sensitive.  
+
* <code><nowiki>https://pranabreath.olekdia.com/</nowiki></code> - Case-sensitive.  
−
* <code><nowiki>https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/</nowiki></code> - Case-sensitive.  
+
* <code><nowiki>https://pranabreath.page.link/?link=https://pranabreath.olekdia.com/</nowiki></code> - Case-sensitive.  
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
* <code>pranabreath://reminders/item?[Parameter]=[Value]</code>
 
* <code>pranabreath://reminders/item?[Parameter]=[Value]</code>
 
* <code>pranabreath://reminders/item?cmd=[Command]&[Parameter1]=[Value1]&[Parameter2]=[Value2]</code>
 
* <code>pranabreath://reminders/item?cmd=[Command]&[Parameter1]=[Value1]&[Parameter2]=[Value2]</code>
−
* <code><nowiki>https://olekdia.com/pranabreath/reminders?cmd=[Command]&[Parameter]=[Value]</nowiki></code> - Case-sensitive.
+
* <code><nowiki>https://pranabreath.olekdia.com/reminders?cmd=[Command]&[Parameter]=[Value]</nowiki></code> - Case-sensitive.
  
 
== Commands ==
 
== Commands ==
Line 23: Line 23:
 
|  
 
|  
 
==='''list'''===
 
==='''list'''===
−
| Returns reminders list. Currently it is only used in console for retrieving reminders list.
+
| Returns reminders list. Currently it is used only in console for retrieving reminders list.
 
* <code>pranabreath://reminders?cmd=list</code>  
 
* <code>pranabreath://reminders?cmd=list</code>  
 
<pre>
 
<pre>
−
pos id public_id name
+
id time training          when
−
0  1  1        Clear mind
+
16 ⁦‎07:‎30⁩ Power             Every day
−
1  2 2        Relax
+
6 ⁦‎18:‎00⁩ Clear mind        Every day
−
2  3  3        Calming
+
8 ⁦‎10:‎00⁩ Heart rate        Sunday
−
3  4  4        Power
+
10 ⁦‎10:‎03⁩ Blood circulation Sunday
−
4  5 5        Harmony
+
11 ⁦‎10:‎05⁩ Buteyko test      Sunday
−
5  6 6        Anti-stress
+
3 ⁦‎10:‎10⁩ Genchi test      Sunday
−
6  7  7        Anti-appetite
 
−
7  8  8        Cigarette replace
 
−
8  9 11        Bhastrika
 
 
</pre>
 
</pre>
−
* <code>pranabreath://reminders</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.
+
* <code>pranabreath://reminders</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.
 
|-
 
|-
 
|  
 
|  
 
==='''create'''===
 
==='''create'''===
−
| Create the training with defined [[#Parameters|parameters]]. If training with such name already exists - new training will not be created. Instead all parameters will be applied to this training.
+
| Create the reminder with defined [[#Parameters|parameters]].  
−
* <code>pranabreath://trainings?cmd=create&name=Serenity&trng_type=1</code> - Create [[Training_kind#Meditation|meditation]] with name "Serenity".
+
* <code>pranabreath://reminders?cmd=create&time=18_30&pid=1</code> - Create a reminder for the training with id equals 1 to 18:30 (6:30 PM).
−
* <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]]
 
 
|-
 
|-
 
|  
 
|  
 
==='''delete'''===
 
==='''delete'''===
−
| Delete the selected training. If there is no the input training - nothing happens.
+
| Delete the selected reminder. If there is no input reminder - nothing happens.
−
* <code>pranabreath://trngs/14?cmd=delete</code> - Delete training with id 14.
+
* <code><nowiki>https://pranabreath.olekdia.com/reminders/13?cmd=delete</nowiki></code> - Delete reminder with id 13.
−
* <code>pranabreath://trngs/Relax?cmd=delete</code> - Delete the [[Relax]] training.
 
 
|}
 
|}
  
Line 59: Line 54:
 
|-
 
|-
 
|  
 
|  
−
==='''name'''===
+
==='''pid'''===
−
| Name of the training.  
+
| Parent ID, reference to the training of the reminder.
−
* <code>pranabreath://trainings/Power?name=Energy</code> - Rename the "Power" training to "Energy".
+
* <code>pranabreath://reminders/3?pid=5</code> - Set a reminder with id equals 3 for a training with id equals 5.
−
* <code>https://olekdia.com/pranabreath/Trainings/5?name=Balance</code> - Rename a training with equals 5, set name as "Balance".
 
 
|-
 
|-
 
|  
 
|  
−
==='''public_id'''===
+
==='''enabled'''===
−
| Indicates public id of the training. All [[Training_type|trainings in this list]] have their own ''public_id''. Readonly value.
+
| Represents the state of reminder. Value range is [true, false].
−
* <code>pranabreath://trngs?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training.
+
* <code>pranabreath://rems/5?enabled=false</code> - Disable the reminder with id equals 5.
 
|-
 
|-
−
|  
+
|
−
==='''trng_type'''===
+
==='''time'''===
−
| Is a [[Training_kind|kind]] of the training. Value range is [0 - [[Training_kind#Breathing_session|breathing session]], 1 - [[Training_kind#Meditation|meditation]]].
+
| Reminder triggering time (it uses 24 hours format: <code>hh_mm</code>).
−
* <code>pranabreath://trainings?cmd=create&name=Serenity&trng_type=1</code> - Create [[Training_kind#Meditation|meditation]] with name "Serenity".
+
* <code>pranabreath://rems/4?time=09_30</code> - Set the reminder time with id equals 4 to 09:30
 
|-
 
|-
−
|  
+
|
−
==='''pos'''===
+
==='''message'''===
−
| Position of the training in the training list.
+
| Message of the reminder. If not specified - reminder has random motivator as a message.
−
* <code>pranabreath://trainings/Clear_mind?pos=9999</code> - Move the [[Clear mind]] training to the very bottom of the list.
+
* <code>pranabreath://rems/1?message=VGhpcyB0cmFpbmluZyBpcyByZWFsbHkgaGVscGZ1bCBhZnRlciBsb25nIGNvbmNlbnRyYXRpb24</code> - Set the reminder message with id equals 1 to "This training is really helpful after long concentration". It totally replaces the previous message if it exists. The message should be [https://en.wikipedia.org/wiki/Base64 Base64] encoded for URL safety.
 
|}
 
|}
 
</div>
 
</div>

Latest revision as of 16:06, 1 April 2019

reminders, or rems - Сollection that gives control over app's reminders.

Prefix

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

Syntax

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

Commands

Command Description

list

 Returns reminders list. Currently it is used only in console for retrieving reminders list.
  • pranabreath://reminders?cmd=list
id time  training          when
16 ⁦‎07:‎30⁩ Power             Every day
6  ⁦‎18:‎00⁩ Clear mind        Every day
8  ⁦‎10:‎00⁩ Heart rate        Sunday
10 ⁦‎10:‎03⁩ Blood circulation Sunday
11 ⁦‎10:‎05⁩ Buteyko test      Sunday
3  ⁦‎10:‎10⁩ Genchi test       Sunday
  • pranabreath://reminders - 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 reminder with defined parameters.
  • pranabreath://reminders?cmd=create&time=18_30&pid=1 - Create a reminder for the training with id equals 1 to 18:30 (6:30 PM).

delete

 Delete the selected reminder. If there is no input reminder - nothing happens.
  • https://pranabreath.olekdia.com/reminders/13?cmd=delete - Delete reminder with id 13.

Parameters

Parameter Description

pid

 Parent ID, reference to the training of the reminder.
  • pranabreath://reminders/3?pid=5 - Set a reminder with id equals 3 for a training with id equals 5.

enabled

 Represents the state of reminder. Value range is [true, false].
  • pranabreath://rems/5?enabled=false - Disable the reminder with id equals 5.

time

 Reminder triggering time (it uses 24 hours format: hh_mm).
  • pranabreath://rems/4?time=09_30 - Set the reminder time with id equals 4 to 09:30

message

 Message of the reminder. If not specified - reminder has random motivator as a message.
  • pranabreath://rems/1?message=VGhpcyB0cmFpbmluZyBpcyByZWFsbHkgaGVscGZ1bCBhZnRlciBsb25nIGNvbmNlbnRyYXRpb24 - Set the reminder message with id equals 1 to "This training is really helpful after long concentration". It totally replaces the previous message if it exists. The message should be Base64 encoded for URL safety.
Retrieved from "https://pranabreath.olekdia.com/index.php?title=Development:Prana_Breath_API/Collections:Reminders&oldid=90583"