Change wording to better describe the class

Signed-off-by: Travis Ralston <travpc@gmail.com>
pull/21833/head
Travis Ralston 2017-10-22 21:00:35 -06:00
parent 8c3e5ebbad
commit e02dcae3b6
1 changed files with 18 additions and 17 deletions

View File

@ -49,27 +49,28 @@ const PRIORITY_MAP = [
]; ];
/** /**
* Controls and manages Granular Settings through use of localStorage, account data, * Controls and manages application settings at different levels through a variety of
* and room state. Granular Settings are user settings that can have overrides at * backends. Settings may be overridden at each level to provide the user with more
* particular levels, notably the device, account, and room level. With the topmost * options for customization and tailoring of their experience. These levels are most
* level being the preferred setting, the override procedure is: * notably at the device, room, and account levels. The preferred order of levels is:
* - localstorage (per-device) * - per-device
* - room account data (per-account in room) * - per-account in a particular room
* - account data (per-account) * - per-account
* - room state event (per-room) * - per-room
* - default (defined by Riot) * - defaults (as defined here)
* *
* There are two types of settings: Account and Room. * There are two types of settings: Account and Room.
* *
* Account Settings use the same override procedure described above, but drop the room * Account Settings use the same preferences described above, but do not look at the
* account data and room state event checks. Account Settings are best used for things * per-account in a particular room or the per-room levels. Account Settings are best
* like which theme the user would prefer. * used for things like which theme the user would prefer.
* *
* Room Settings use the exact override procedure described above. Room Settings are * Room settings use the exact preferences described above. Room Settings are best
* best suited for settings which room administrators may want to define a default * suited for settings which room administrators may want to define a default for the
* for members of the room, such as the case is with URL previews. Room Settings may * room members, or where users may want an individual room to be different. Using the
* also elect to not allow the room state event check, allowing for per-room settings * setting definitions, particular preferences may be excluded to prevent, for example,
* that are not defaulted by the room administrator. * room administrators from defining that all messages should have timestamps when the
* user may not want that. An example of a Room Setting would be URL previews.
*/ */
export default class GranularSettingStore { export default class GranularSettingStore {
/** /**