Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    UserSettingsService Class

    Extends Service
    Defined in: addon/services/user-settings.js:21
    Module: ember-flexberry

    Service to store/read user settings to/from application storage.

    Methods

    _deleteExistingRecord

    (
    • componentName
    • settingName
    )
    Promise private

    Defined in addon/services/user-settings.js:846

    Deletes user settings record.

    Parameters:

    • componentName Object

      Module name of looked for record.

    • settingName String

      Setting name of looked for record.

    Returns:

    Promise:

    Promises array.

    _getExistingRecord

    (
    • componentName
    • settingName
    )
    Promise private

    Defined in addon/services/user-settings.js:884

    Looks for already created user settings record.

    Parameters:

    • componentName Object

      Module name of looked for record.

    • settingName String

      Setting name of looked for record.

    Returns:

    Promise:

    A promise that returns founded record or undefined if there is no such setting.

    _getExistingSettings

    (
    • componentName
    • settingName
    )
    Promise private

    Defined in addon/services/user-settings.js:920

    Looks for all created user settings records.

    Parameters:

    • componentName String

      Component name of looked for record.

    • settingName String

      Setting name of looked for record.

    Returns:

    Promise:

    A promise that returns found record or undefined if there is no such setting.

    _getUserSettings

    () Object

    Defined in addon/services/user-settings.js:761

    Returns user setting for current appPage from storage.

    Returns:

    Object:

    _mergeSettings

    (
    • setting1
    • setting2
    )
    Object private

    Defined in addon/services/user-settings.js:815

    Merge two settings.

    Parameters:

    • setting1 Object

      base settings.

    • setting2 Object

      additions settings.

    Returns:

    Object:

    merged settings.

    _setCurrentUserSettings

    (
    • appPageUserSettings
    )
    Object

    Defined in addon/services/user-settings.js:777

    Merge current developerUserSettings with appPageUserSettings

    Parameters:

    • appPageUserSettings Object

      merged userSettings

    Returns:

    Object:

    createDefaultUserSetting

    (
    • componentName
    )

    Defined in addon/services/user-settings.js:337

    Creates default user setting if setting for specified component isn't exists.

    Parameters:

    deleteUserSetting

    (
    • [options]
    • componentName
    • settingName
    )
    Promise

    Defined in addon/services/user-settings.js:645

    Deletes given user setting from storage.

    Parameters:

    • [options] Object optional

      Parameters for user setting getting.

    • componentName String

      component Name to search by.

    • settingName String

      Setting name to search by.

    Returns:

    Promise:

    Promises array

    exists

    () Boolean

    Defined in addon/services/user-settings.js:313

    Returns true if userSettings for current appPage exists.

    Returns:

    Boolean:

    exists

    () Boolean

    Defined in addon/services/user-settings.js:324

    Returns true if default userSettings for current appPage exists.

    Returns:

    Boolean:

    getCurrentAppName

    () String

    Defined in addon/services/user-settings.js:154

    Get current App Name.

    Returns:

    String:

    getCurrentAppPage

    () String

    Defined in addon/services/user-settings.js:144

    Get current App Page.

    Returns:

    String:

    getCurrentColsOrder

    (
    • componentName
    • settingName
    )
    Array

    Defined in addon/services/user-settings.js:489

    Returns current colsOrder .

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Array:

    getCurrentColumnWidths

    (
    • componentName
    • settingName
    )
    Array

    Defined in addon/services/user-settings.js:502

    Returns current columnWidths.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Array:

    getCurrentPerPage

    (
    • componentName
    • settingName
    )
    Array

    Defined in addon/services/user-settings.js:463

    Returns current perPageValue .

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Array:

    getCurrentSorting

    (
    • componentName
    • settingName
    )
    Array

    Defined in addon/services/user-settings.js:450

    Returns current sorting .

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Array:

    getCurrentUserSetting

    (
    • componentName
    • settingName
    )
    String

    Defined in addon/services/user-settings.js:405

    Returns current userSetting.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    String:

    getCurrentWebPage

    () String

    Defined in addon/services/user-settings.js:134

    Get current Web Page.

    Returns:

    String:

    getDefaultDeveloperUserSetting

    (
    • componentName
    )
    Object

    Defined in addon/services/user-settings.js:429

    Returns default developer user settings for component.

    Parameters:

    • componentName String

      Name of component.

    Returns:

    Object:

    getDetSeparateCols

    (
    • componentName
    • settingName
    )
    Boolean

    Defined in addon/services/user-settings.js:515

    Returns current detSeparateCols.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Boolean:

    getDetSeparateRows

    (
    • componentName
    • settingName
    )
    Boolean

    Defined in addon/services/user-settings.js:528

    Returns current detSeparateRows.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    Returns:

    Boolean:

    getListComponentNames

    () Ember.NativeArray

    Defined in addon/services/user-settings.js:267

    Get list components Names.

    Returns:

    Ember.NativeArray:

    getListCurrentNamedUserSetting

    () String

    Defined in addon/services/user-settings.js:385

    Returns current list of named userSetting.

    Returns:

    String:

    getListCurrentUserSetting

    () String

    Defined in addon/services/user-settings.js:357

    Returns current list of userSetting.

    Returns:

    String:

    getOfflineSchema

    () Object

    Defined in addon/services/offline-globals.js:5

    Get offline schema.

    Returns:

    Object:

    Returns offline schema.

    getTogglerStatus

    (
    • componentName
    )
    Boolean

    Defined in addon/services/user-settings.js:628

    Returns toggler status from user service.

    Parameters:

    • componentName String

      component Name to search by.

    Returns:

    Boolean:

    Saved status.

    saveUserSetting

    (
    • componentName
    • settingName
    • userSetting
    )
    Promise

    Defined in addon/services/user-settings.js:686

    Saves given user setting to storage.

    Parameters:

    • componentName String

      Name of module for what setting is saved.

    • settingName String

      Setting name to save as.

    • userSetting String

      User setting data to save.

    Returns:

    Promise:

    Save operation promise.

    setCurrentColumnWidths

    (
    • componentName
    • settingName
    • columnWidths
    )

    Defined in addon/services/user-settings.js:541

    Set current columnWidths.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    • columnWidths Array

      List columns width.

    setCurrentParams

    (
    • params
    )
    String

    Defined in addon/services/user-settings.js:285

    Implements current URL-params to currentUserSettings

    Parameters:

    Returns:

    String:

    URL params

    setCurrentPerPage

    (
    • componentName
    • settingName
    • perPageValue
    )

    Defined in addon/services/user-settings.js:570

    Set current perPage.

    Parameters:

    • componentName String

      Name of component.

    • settingName String

      Name of setting.

    • perPageValue Int

      Per page value.

    setCurrentWebPage

    (
    • webPage.
    )

    Defined in addon/services/user-settings.js:123

    Set current Web Page.

    Parameters:

    setDefaultDeveloperUserSettings

    (
    • developerUserSettings.
    )

    Defined in addon/services/user-settings.js:243

    Set initial userSetting for current webPage, defined by application developer

    Parameters:

    • developerUserSettings. Object

    setDeveloperUserSettings

    (
    • developerUserSettings.
    )

    Defined in addon/services/user-settings.js:164

    Set initial userSetting for current webPage, defined by application developer Structure of developerUserSettings: { : { : { colsOrder: [ { propName :, hide: true|false }, ... ], sorting: [{ propName: , direction: "asc"|"desc" }, ... ], colsWidths: [ :, ... ], }, ... }, ... } For default userSetting use empty name (''). may contain any of properties: colsOrder, sorting, colsWidth or being empty.

    Parameters:

    • developerUserSettings. Object

    setTogglerStatus

    (
    • componentName
    • togglerStatus
    )

    Defined in addon/services/user-settings.js:599

    Set toggler status

    Parameters:

    • componentName String

      Name of component.

    • togglerStatus Boolean

      Status to save.

    Properties

    _store

    DS.Store private

    Defined in addon/services/user-settings.js:28

    Ember data store.

    appName

    String

    Defined in addon/services/user-settings.js:56

    Current Application name.

    Default: ''

    beforeParamUserSettings

    Object

    Defined in addon/services/user-settings.js:92

    User settings for all pages before params applying.

    Default: {}

    currentAppPage

    String

    Defined in addon/services/user-settings.js:74

    Current App page.

    Default: ''

    currentUserSettings

    Object

    Defined in addon/services/user-settings.js:101

    Current user settings for all pages

    Default: {}

    currentWebPage

    String

    Defined in addon/services/user-settings.js:65

    Current WEB page.

    Default: ''

    defaultDeveloperUserSettings

    Object

    Defined in addon/services/user-settings.js:47

    User settings for all pages defined by developer

    Default: {}

    developerUserSettings

    Object

    Defined in addon/services/user-settings.js:83

    User settings for all pages defined by developer

    Default: {}

    enabled

    Boolean

    Defined in addon/services/perf.js:12

    Flag indicates whether perf service is enabled or not.

    Default: false

    Example:

    // PerfServise 'enabled' setting could be also defined through application config/environment.js
                    module.exports = function(environment) {
                      let ENV = {
                        ...
                        APP: {
                          ...
                          perf: {
                            enabled: true
                          }
                          ...
                        }
                        ...
                    };

    isUserSettingsServiceEnabled

    Boolean

    Defined in addon/services/user-settings.js:37

    Flag: indicates whether to use user settings service (if true) or not (if false). This flag is readed from config setting APP.useUserSettingsService and can be changed programatically later.

    Default: false