Options
All
  • Public
  • Public/Protected
  • All
Menu
     

Interface SpaceHandler

Hierarchy

  • SpaceHandler

Index

Properties

Methods

Properties

Data

Data: [CBSpaceStruct]

The default structure of any data that it to be recieved from a CFG.SPCE.SpaceHandler.Call.

Methods

Call

  • When a page is request by a Client, this function is called to build a request that is needed in order the render said page. This can request User Data for a Profile Page, perform a Query Data for a Search Page, etc. The result is then passed to the SpaceHandler.Build function which you can then use to build the page.

    Parameters

    • path: string

      The path from the current page-request.

    • params: TPQryPathParams

      The path parameters from the current page-request; if any.

    • query: TPQryObject

      The query parameters from the current GET/DELETE page-request; if any.

    • body: TPQryObject

      The body parameters from the current POST/PUT page-request; if any.

    • files: string[]

      A list a files from the current page-request, that are to be uploaded in this request.

    • user: __type

      The user-session object from the current page-request.

    Returns QYRequest

Build

  • Build(Actions: Actions, Stores: any, LID: any): function

  • This is where the magic happens. The... Automagic (lol). After SpaceHandler.Call returns a response, it is passed to this function which server as your handling of the pages stucture data. Think of it as scaffolding.

    Parameters

    • Actions: Actions
    • Stores: any
    • LID: any

    Returns function