Development:Prana Breath API/Collections:Reminders - Revision history

Oleksandr at 16:06, 1 April 2019

2019-04-01T16:06:22Z

Nadia at 17:23, 1 February 2019

2019-02-01T17:23:58Z

Oleksandr at 16:31, 1 February 2019

2019-02-01T16:31:13Z

Oleksandr: /* delete */

2019-02-01T16:13:37Z

‎delete

Oleksandr at 15:14, 1 February 2019

2019-02-01T15:14:27Z

Oleksandr: /* delete */

2019-02-01T14:39:30Z

‎delete

Oleksandr: /* enabled */

2019-02-01T14:39:08Z

‎enabled

Oleksandr: /* time */

2019-02-01T14:38:00Z

‎time

Oleksandr: /* time */

2019-02-01T14:36:34Z

‎time

Oleksandr at 14:32, 1 February 2019

2019-02-01T14:32:36Z

@@ Line 6: / Line 6: @@
 == Prefix ==
 * <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 ==
@@ Line 13: / Line 13: @@
 * <code>pranabreath://reminders/item?[Parameter]=[Value]</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 ==
@@ Line 44: / Line 44: @@
 ==='''delete'''===
 | Delete the selected reminder. If there is no input reminder - nothing happens.
-* <code><nowiki>https://olekdia.com/pranabreath/reminders/13?cmd=delete</nowiki></code> - Delete reminder with id 13.
+* <code><nowiki>https://pranabreath.olekdia.com/reminders/13?cmd=delete</nowiki></code> - Delete reminder with id 13.
 |}

@@ Line 23: / Line 23: @@
+|
 ==='''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>
 <pre>
@@ Line 34: / Line 34: @@
   ⁦‎10:‎10⁩ Genchi test       Sunday
 </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 the reminder with defined [[#Parameters|parameters]].
-* <code>pranabreath://reminders?cmd=create&time=18_30&pid=1</code> - Create a reminder for the training with id equals 1, at 18:30.
+* <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).
 |-
+|
 ==='''delete'''===
-| Delete the selected reminder. If there is no the input reminder - nothing happens.
+| Delete the selected reminder. If there is no input reminder - nothing happens.
 * <code><nowiki>https://olekdia.com/pranabreath/reminders/13?cmd=delete</nowiki></code> - Delete reminder with id 13.
 |}
@@ Line 60: / Line 60: @@
+|
 ==='''enabled'''===
-| Represents state of reminder. Values range [true, false]
+| Represents the state of reminder. Value range is [true, false].
 * <code>pranabreath://rems/5?enabled=false</code> - Disable the reminder with id equals 5.
 |-
@@ Line 70: / Line 70: @@
+|
 ==='''message'''===
-| Message of the reminder. If not specified - reminder would have random motivator as a message.
+| Message of the reminder. If not specified - reminder has random motivator as a message.
-* <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 previous message if it exists. The message should be [https://en.wikipedia.org/wiki/Base64 Base64] encoded for the URL safety.
+* <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>

← Older revision		Revision as of 16:31, 1 February 2019
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 44: / Line 44: @@
 ==='''delete'''===
 | Delete the selected reminder. If there is no the input reminder - nothing happens.
-* <code><nowiki>https://olekdia.com/pranabreath/reminders/13?cmd=delete</nowiki></code> - Delete training with id 13.
+* <code><nowiki>https://olekdia.com/pranabreath/reminders/13?cmd=delete</nowiki></code> - Delete reminder with id 13.
 |}

@@ Line 64: / Line 64: @@
 |-
+|
 ==='''time'''===
 | Reminder triggering time (it uses 24 hours format: <code>hh_mm</code>).
 * <code>pranabreath://rems/4?time=09_30</code> - Set the reminder time with id equals 4 to 09:30
 |}
 </div>

@@ Line 26: / Line 26: @@
 * <code>pranabreath://reminders?cmd=list</code>
 <pre>
-pos id public_id name
+id time  training          when
-   1  1         Clear mind
+⁦‎07:‎30⁩ Power             Every day
-   2  2         Relax
+⁦‎18:‎00⁩ Clear mind        Every day
-   3  3         Calming
+⁦‎10:‎00⁩ Heart rate        Sunday
-   4  4         Power
+⁦‎10:‎03⁩ Blood circulation Sunday
-   5  5         Harmony
+⁦‎10:‎05⁩ Buteyko test      Sunday
-   6  6         Anti-stress
+⁦‎10:‎10⁩ Genchi test       Sunday
 </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.
@@ Line 41: / Line 38: @@
+|
 ==='''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, at 18:30.
 |-
+|
 ==='''delete'''===
-| Delete the selected training. If there is no the input training - nothing happens.
+| Delete the selected reminder. If there is no the input reminder - nothing happens.
-* <code>pranabreath://trngs/14?cmd=delete</code> - Delete training with id 14.
+* <code>https://olekdia.com/pranabreath/reminders/13?cmd=delete</code> - Delete training with id 13.
 |}
@@ 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.
 |-
+|
-==='''public_id'''===
+==='''enabled'''===
-| Indicates public id of the training. All [[Training_type|trainings in this list]] have their own ''public_id''. Readonly value.
+| Represents state of reminder. Values range [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.
 |-
+|
-==='''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]]].
+| Represents state of reminder. Values range [true, false]
-* <code>pranabreath://trainings?cmd=create&name=Serenity&trng_type=1</code> - Create [[Training_kind#Meditation|meditation]] with name "Serenity".
+* <code>pranabreath://trngs?cmd=import&public_id=25</code> - Import training with <code>public_id</code> equals 25 which is [[Ha breathing]] training.
 |}
 </div>