contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers

Class versions

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by coldbox.system.RestHandler
          extended by cborm.models.resources.BaseHandler
            extended by contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
              extended by contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.versions

RESTFul CRUD for Content Versions An incoming site identifier is required An incoming contentID or slug is required

Class Attributes:
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
  • secured : PAGES_ADMIN,PAGES_EDITOR,ENTRIES_ADMIN,ENTRIES_EDITOR,CONTENTSTORE_ADMIN,CONTENTSTORE_EDITOR
  •  
    Property Summary
    type property default serializable required
    any contentService


    • access = public
    • returntype = any
    • inject = contentService@contentbox
    true false
    any ormService


    • access = public
    • returntype = any
    • inject = contentVersionService@contentbox
    true false
    Method Summary
    any delete([any event], [any rc], [any prc])
         Delete a version from a specific content item.
    any index([any event], [any rc], [any prc])
         Display all versions for the requested contentype.
    any preHandler([any event], [any rc], [any prc], [any action], [any eventArguments])
         Executes before all handler actions.
    any show([any event], [any rc], [any prc])
         Show a content version individually.
     
    Methods inherited from class contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
    autoCast, create, getByIdOrSlugOrFail, getMaxRows, getPageOffset, getSiteByIdOrSlugOrFail, newCriteria, update
     
    Methods inherited from class cborm.models.resources.BaseHandler
    None
     
    Methods inherited from class coldbox.system.RestHandler
    aroundHandler, onAnyOtherException, onAuthenticationFailure, onAuthorizationFailure, onEntityNotFoundException, onError, onExpectationFailed, onInvalidHTTPMethod, onInvalidRoute, onMissingAction, onValidationException
     
    Methods inherited from class coldbox.system.EventHandler
    _actionExists, _actionMetadata, _privateInvoker, init, onHandlerDIComplete
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    announce, announceInterception, async, back, externalView, forAttribute, getCache, getCachebox, getColdBoxSetting, getController, getDateTimeHelper, getEnv, getFlash, getFlow, getInstance, getIsoTime, getJsonUtil, getLog, getLogBox, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getRootWireBox, getSetting, getSystemProperty, getSystemSetting, getUserSessionIdentifier, getWirebox, ifNull, ifPresent, inDebugMode, includeUDF, isDevelopment, isProduction, isTesting, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populate, populateModel, relocate, renderExternalView, renderLayout, renderview, runEvent, runRoute, setCachebox, setController, setEnv, setFlash, setFlow, setJsonUtil, setLog, setLogBox, setSetting, setWirebox, settingExists, throwIf, throwUnless, toJson, unless, view, when
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    contentService

    property any contentService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - contentService@contentbox
    serializable - true

    ormService

    property any ormService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - contentVersionService@contentbox
    serializable - true

    Method Detail

    delete

    public any delete([any event], [any rc], [any prc])

    Delete a version from a specific content item

    Overrides:
    delete in class baseHandler
    Parameters:
    event
    rc
    prc

    index

    public any index([any event], [any rc], [any prc])

    Display all versions for the requested contentype

    Overrides:
    index in class baseHandler
    Parameters:
    event
    rc
    prc

    preHandler

    public any preHandler([any event], [any rc], [any prc], [any action], [any eventArguments])

    Executes before all handler actions

    Parameters:
    event
    rc
    prc
    action
    eventArguments

    show

    public any show([any event], [any rc], [any prc])

    Show a content version individually

    Overrides:
    show in class baseHandler
    Parameters:
    event
    rc
    prc