OpenVeo Core server

API Docs for: 7.0.0
Show:

SettingsController

Extends EntityController
Defined in: app/server/controllers/SettingsController.js:14
Module: core-controllers

Summary

Defines an entity controller to handle requests relative to settings.

Constructor

SettingsController

Defined in app/server/controllers/SettingsController.js:14

Syntax

SettingsController

()

Summary

Methods

getEntitiesAction

Defined in app/server/controllers/SettingsController.js:28

Syntax

getEntitiesAction

(
  • request
  • response
  • next
)
async

Summary

Gets settings.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • [query] Object optional

      Request query

      • [limit] Number optional
        A limit number of settings to retrieve per page (default to 10)
      • [page] Number optional
        The page number started at 0 for the first page (default to 0)
      • [sortOrder] String optional
        Either "asc" for ascendant or "desc" for descendant
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

Example:

// Response example
{
  "entities" : [ ... ],
  "pagination" : {
    "limit": ..., // The limit number of settings by page
    "page": ..., // The actual page
    "pages": ..., // The total number of pages
    "size": ... // The total number of settings
}

getEntityAction

Defined in app/server/controllers/SettingsController.js:92

Syntax

getEntityAction

(
  • request
  • response
  • next
)
async

Summary

Gets a specific setting.

If setting is not found it is sent with value null.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • params Object

      Request's parameters

      • id String
        The setting id to retrieve
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

Example:

// Response example
{
  "entity" : { ... }
}

getProvider

Defined in app/server/controllers/SettingsController.js:139

Syntax

getProvider

() SettingsProvider

Summary

Gets an instance of the provider associated to the controller.

Returns:

SettingsProvider:

The provider