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

From Olekdia Wiki
(→‎delete)
Line 64: Line 64:
 
|-
 
|-
 
|
 
|
−
 
 
==='''time'''===
 
==='''time'''===
 
| Reminder triggering time (it uses 24 hours format: <code>hh_mm</code>).
 
| 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
 
* <code>pranabreath://rems/4?time=09_30</code> - Set the reminder time with id equals 4 to 09:30
 +
|-
 +
|
 +
==='''message'''===
 +
| Message of the reminder. If not specified - reminder would have 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.
 
|}
 
|}
 
</div>
 
</div>

Revision as of 15:14, 1 February 2019

reminders, or rems - collection that gives you control over reminders 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://reminders/item?cmd=[Command] - Case-insensitive.
  • pranabreath://reminders/item?[Parameter]=[Value]
  • pranabreath://reminders/item?cmd=[Command]&[Parameter1]=[Value1]&[Parameter2]=[Value2]
  • https://olekdia.com/pranabreath/reminders?cmd=[Command]&[Parameter]=[Value] - Case-sensitive.

Commands

Command Description

list

 Returns reminders list. Currently it is only used 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 when only 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, at 18:30.

delete

 Delete the selected reminder. If there is no the input reminder - nothing happens.
  • https://olekdia.com/pranabreath/reminders/13?cmd=delete - Delete training 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 state of reminder. Values range [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 would have 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 previous message if it exists. The message should be Base64 encoded for the URL safety.
Retrieved from "https://pranabreath.info/index.php?title=Development:Prana_Breath_API/Collections:Reminders&oldid=84528"