Development:Prana Breath API/Collections:Settings

From Olekdia Wiki
< Development:Prana Breath API
Revision as of 10:55, 28 November 2019 by Oleksandr (talk | contribs) (list)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

settings - Сollection that gives control over app's settings.

Prefix

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

Syntax

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

Commands

Command Description

list

Returns settings list. Currently it is used only in console for retrieving settings list.
  • pranabreath://settings?cmd=list
Items:
theme
screenBehaviorPref
notifBehaviorPref
breathMethodsOrientPref
trngChartPref
statChartPref
mutePref
  • pranabreath://settings - It is a default command if 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" as a training chart.
  • pranabreath://settings/trngChartPref?val=asteroids - Set "Asteroids" as a training chart. Select is a default command if ?cmd= is omitted.


Items

Item Description

theme

Allows to adjust color theme setting.
  • pranabreath://settings/theme?value=dark - Set purple dark theme.

Possible values:

  • violet
  • blue
  • olive
  • gray
  • green
  • yellow
  • red
  • monochromatic

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 - Mute all sounds within the app.
  • false - Return sounds to normal volume.