lucee.Componentcoldbox.system.FrameworkSupertype
coldbox.system.EventHandler
coldbox.system.RestHandler
cborm.models.resources.BaseHandler
contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.authors
RESTFul CRUD for Authors Only tokens with the `AUTHOR_ADMIN` can interact with this endpoint
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
ormService
|
true
|
false
|
|
any
|
permissionService
|
true
|
false
|
|
any
|
roleService
|
true
|
false
|
Method Summary | |
---|---|
any
|
create([any event], [any rc], [any prc])
Create an author in ContentBox. |
any
|
delete([any event], [any rc], [any prc])
Delete an author using an id. |
any
|
index([any event], [any rc], [any prc])
Display all authors according to query options. |
any
|
show([any event], [any rc], [any prc])
Show an author using the id. |
any
|
update([any event], [any rc], [any prc])
Update an existing author. |
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 |
---|
access
- publicrequired
- falsereturntype
- anyinject
- AuthorService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- permissionService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- roleService@contentboxserializable
- trueMethod Detail |
---|
Create an author in ContentBox
create
in class
baseHandler
event
rc
prc
Delete an author using an id
delete
in class
baseHandler
event
rc
prc
Display all authors according to query options
index
in class
baseHandler
event
rc
prc
Show an author using the id
show
in class
baseHandler
event
rc
prc
Update an existing author
update
in class
baseHandler
event
rc
prc