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

From Olekdia Wiki
(→‎breathMethodsOrientPref)
(→‎mutePref)
Line 122: Line 122:
  
 
==='''mutePref'''===
 
==='''mutePref'''===
−
| TODO
+
| Allows to adjust mute setting.<br/>
 +
Possible values:
 +
* <code>true</code> - All sounds are muted.
 +
* <code>false</code> - All sounds returned to normal volume.
 
|}
 
|}
  
 
{{DISPLAYTITLE:<span style="position:absolute; top:-9999px;">Development:</span>Prana Breath API/Collections:Settings}}
 
{{DISPLAYTITLE:<span style="position:absolute; top:-9999px;">Development:</span>Prana Breath API/Collections:Settings}}
 
[[Category:Dev{{#translation:}}|^Prana Breath^]]
 
[[Category:Dev{{#translation:}}|^Prana Breath^]]

Revision as of 13:38, 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

 Allows to adjust statistics chart setting.

Possible values:

  • bar
  • line

notifBehaviorPref

 Allows to adjust notification during training setting.

Possible values:

  • TIME
  • PROGRESS
  • TIME,PROGRESS

breathMethodsOrientPref

 Allows to adjust breath methods setting.

Possible values:

  • 0 - "As it is"
  • 1 - "As in a mirror"

mutePref

 Allows to adjust mute setting.

Possible values:

  • true - All sounds are muted.
  • false - All sounds returned to normal volume.
Retrieved from "https://time-planner.info/index.php?title=Development:Prana_Breath_API/Collections:Settings&oldid=84500"