OpenVeo Core server

API Docs for: 7.0.0
Show:

GroupController

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

Summary

Defines an entity controller to handle requests relative to groups' entities.

Constructor

GroupController

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

Syntax

GroupController

()

Summary

Item Index

Methods

Methods

getEntitiesAction

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

Syntax

getEntitiesAction

(
  • request
  • response
  • next
)

Summary

Gets a list of groups.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • [query] Object optional

      Request's query parameters

      • [include] String | Array optional
        The list of fields to include from returned groups
      • [exclude] String | Array optional
        The list of fields to exclude from returned groups. Ignored if include is also specified.
      • [query] String optional
        Search query to search on both group names and descriptions
      • [useSmartSearch=1] Number optional
        1 to use a more advanced search mechanism, 0 to use a simple search based on a regular expression
      • [page=0] Number optional
        The expected page in pagination system
      • [limit=10] Number optional
        The maximum number of expected results
      • [sortBy="name"] String optional
        The field to sort by (either "name" or "description")
      • [sortOrder="desc"] String optional
        The sort order (either "asc" or "desc")
  • 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 groups by page
    "page": ..., // The actual page
    "pages": ..., // The total number of pages
    "size": ... // The total number of groups
}

getProvider

Defined in app/server/controllers/GroupController.js:121

Syntax

getProvider

() GroupProvider

Summary

Gets an instance of the provider associated to the controller.

Returns:

GroupProvider:

The provider