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

From Olekdia Wiki
(→‎trngChartPref)
(→‎themePref)
Line 52: Line 52:
 
|  
 
|  
 
==='''themePref'''===
 
==='''themePref'''===
−
| Allows to adjust [[Settings_tab#Theme|theme]] of the app.
+
| Allows to adjust [[Settings_tab#Theme|theme]] setting.
−
* <code>pranabreath://settings/theme?value=dark</code> - Set purple dark theme.
+
* <code>pranabreath://settings/theme?value=dark</code> - Set purple dark theme.<br/>
−
* Possible values: <code>light</code>, <code>dark</code>, <code>blue_light</code>, <code>blue_dark</code>, <code>gray_light</code>, <code>gray_dark</code>, <code>green_light</code>, <code>green_dark</code>, <code>olive_light</code>, <code>olive_dark</code>, <code>yellow_light</code>, <code>yellow_dark</code>, <code>red_light</code>, <code>red_dark</code>, <code>white</code>, <code>black</code>
+
* Possible values:  
 +
* <code>light</code>
 +
* <code>dark</code>
 +
* <code>blue_light</code>
 +
* <code>blue_dark</code>
 +
* <code>gray_light</code>
 +
* <code>gray_dark</code>
 +
* <code>green_light</code>
 +
* <code>green_dark</code>
 +
* <code>olive_light</code>
 +
* <code>olive_dark</code>
 +
* <code>yellow_light</code>
 +
* <code>yellow_dark</code>
 +
* <code>red_light</code>
 +
* <code>red_dark</code>
 +
* <code>white</code>
 +
* <code>black</code>
 
|-
 
|-
−
|  
+
|
 +
 
 
==='''screenBehaviorPref'''===
 
==='''screenBehaviorPref'''===
 
| Allows to adjust [[Settings_tab#Screen_during_training|screen during training]] setting.<br/>
 
| Allows to adjust [[Settings_tab#Screen_during_training|screen during training]] setting.<br/>

Revision as of 13:22, 1 February 2019

settings - collection that gives you control over app's settings.

Prefix

  • pranabreath://
  • https://olekdia.com/pranabreath/
  • https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/

Syntax

  • pranabreath://settings/item?val=[Value] - Case-insensitive.
  • pranabreath://settings/item?cmd=[Command]&val=[Value]
  • https://olekdia.com/pranabreath/settings?val=[Value] - Case-sensitive.

Commands

Command Description

list

 Returns settings list. Currently it is only used in console for retrieving settings list.
  • pranabreath://settings?cmd=list
Items:
themePref
screenBehaviorPref
notifBehaviorPref
breathMethodsOrientPref
trngChartPref
statChartPref
mutePref
  • pranabreath://settings - 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.

set

 Allows to set a specific setting value.
  • pranabreath://settings/trngChartPref?cmd=set&val=asteroids - Set "Asteroids" training chart.
  • pranabreath://settings/trngChartPref?val=asteroids - It is default command when item is specified, so it will have the same impact that above example.


Items

Item Description

themePref

 Allows to adjust theme setting.
  • pranabreath://settings/theme?value=dark - Set purple dark theme.
  • Possible values:
  • light
  • dark
  • blue_light
  • blue_dark
  • gray_light
  • gray_dark
  • green_light
  • green_dark
  • olive_light
  • olive_dark
  • yellow_light
  • yellow_dark
  • red_light
  • red_dark
  • white
  • black

screenBehaviorPref

 Allows to adjust screen during training setting.

Possible values:

  • def
  • off
  • on
  • animCycle
  • animPhase

trngChartPref

 Allows to adjust training chart setting.

Possible values:

  • none
  • ring
  • line
  • sphere
  • asteroids

statChartPref

 TODO

notifBehaviorPref

 TODO

breathMethodsOrientPref

 TODO

mutePref

 TODO
Retrieved from "https://pranabreath.info/index.php?title=Development:Prana_Breath_API/Collections:Settings&oldid=84493"