contentbox.modules.contentbox-admin.handlers

Class authors

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by coldbox.system.RestHandler
          extended by contentbox.modules.contentbox-admin.handlers.baseHandler
            extended by contentbox.modules.contentbox-admin.handlers.authors

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manage ContentBox users

Class Attributes:
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any authorService


    • access = public
    • returntype = any
    • inject = authorService@contentbox
    true false
    any editorService


    • access = public
    • returntype = any
    • inject = editorService@contentbox
    true false
    any entryService


    • access = public
    • returntype = any
    • inject = entryService@contentbox
    true false
    any markdownEditor


    • access = public
    • returntype = any
    • inject = markdownEditor@contentbox-markdowneditor
    true false
    any paging


    • access = public
    • returntype = any
    • inject = paging@contentbox
    true false
    any permissionGroupService


    • access = public
    • returntype = any
    • inject = permissionGroupService@contentbox
    true false
    any permissionService


    • access = public
    • returntype = any
    • inject = permissionService@contentbox
    true false
    any roleService


    • access = public
    • returntype = any
    • inject = roleService@contentbox
    true false
    any securityService


    • access = public
    • returntype = any
    • inject = securityService@contentbox
    true false
    any twoFactorService


    • access = public
    • returntype = any
    • inject = twoFactorService@contentbox
    true false
    Method Summary
    any changeEditor([any event], [any rc], [any prc])
         change user editor preferences.
    any doGlobalPasswordReset([any event], [any rc], [any prc])
         Issue a global password reset for all users in the system.
    any doNew([any event], [any rc], [any prc])
         Create a new user in the system.
    any doPasswordReset([any event], [any rc], [any prc])
         Issue a password reset for the user.
    any editor([any event], [any rc], [any prc])
         Author editor panel.
    any emailCheck([any event], [any rc], [any prc])
         System email checks.
    any export([any event], [any rc], [any prc])
         Export a user.
    any exportAll([any event], [any rc], [any prc])
         Export multiple users.
    any importAll([any event], [any rc], [any prc])
         Import all users.
    any index([any event], [any rc], [any prc])
         List system authors.
    any indexTable([any event], [any rc], [any prc])
         Build out system author's table + filters.
    private any listPreferences([any event], [any rc], [any prc])
         List author preferences.
    any myprofile([any event], [any rc], [any prc])
         Shortcut to author profile.
    any new([any event], [any rc], [any prc])
         New author wizard.
    any passwordChange([any event], [any rc], [any prc])
         Change user password.
    any permissions([any event], [any rc], [any prc])
         Display permissions tab.
    any preHandler([any event], [any rc], [any prc], [any action], [any eventArguments])
         Pre handler.
    any remove([any event], [any rc], [any prc])
         Remove a user.
    any removePermission([any event], [any rc], [any prc])
         Remove permission to a author and gracefully end.
    any removePermissionGroup([any event], [any rc], [any prc])
         Remove permission to a author and gracefully end.
    any save([any event], [any rc], [any prc])
         Save user.
    any savePermission([any event], [any rc], [any prc])
         Save permission to the author and gracefully end.
    any savePermissionGroup([any event], [any rc], [any prc])
         Save permission groups to the author and gracefully end.
    any savePreferences([any event], [any rc], [any prc])
         Save user preferences from the built UI from them.
    any saveRawPreferences([any event], [any rc], [any prc])
         Save raw preferences.
    any saveSinglePreference([any event], [any rc], [any prc])
         Save a user preference usually called asynchronously.
    any usernameCheck([any event], [any rc], [any prc])
         System username checks.
     
    Methods inherited from class contentbox.modules.contentbox-admin.handlers.baseHandler
    getMaxRows, getPageOffset
     
    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

    authorService

    property any authorService

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

    editorService

    property any editorService

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

    entryService

    property any entryService

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

    markdownEditor

    property any markdownEditor

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

    paging

    property any paging

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

    permissionGroupService

    property any permissionGroupService

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

    permissionService

    property any permissionService

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

    roleService

    property any roleService

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

    securityService

    property any securityService

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

    twoFactorService

    property any twoFactorService

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

    Method Detail

    changeEditor

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

    change user editor preferences

    Parameters:
    event
    rc
    prc

    doGlobalPasswordReset

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

    Issue a global password reset for all users in the system.

    Parameters:
    event
    rc
    prc

    doNew

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

    Create a new user in the system You must have the AUTHOR_ADMIN permission to execute

    Parameters:
    event
    rc
    prc

    doPasswordReset

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

    Issue a password reset for the user

    Parameters:
    event
    rc
    prc

    editor

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

    Author editor panel

    Parameters:
    event
    rc
    prc
    Returns:
    html

    emailCheck

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

    System email checks

    Parameters:
    event
    rc
    prc
    Returns:
    json

    export

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

    Export a user

    Parameters:
    event
    rc
    prc

    exportAll

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

    Export multiple users

    Parameters:
    event
    rc
    prc

    importAll

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

    Import all users

    Parameters:
    event
    rc
    prc

    index

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

    List system authors

    Parameters:
    event
    rc
    prc
    Returns:
    html

    indexTable

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

    Build out system author's table + filters

    Parameters:
    event
    rc
    prc
    Returns:
    html

    listPreferences

    private any listPreferences([any event], [any rc], [any prc])

    List author preferences

    Parameters:
    event
    rc
    prc
    Returns:
    view

    myprofile

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

    Shortcut to author profile

    Parameters:
    event
    rc
    prc
    Returns:
    html

    new

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

    New author wizard You must have the AUTHOR_ADMIN permission to execute

    Parameters:
    event
    rc
    prc

    passwordChange

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

    Change user password

    Parameters:
    event
    rc
    prc

    permissions

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

    Display permissions tab

    Parameters:
    event
    rc
    prc

    preHandler

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

    Pre handler

    Parameters:
    event
    rc
    prc
    action
    eventArguments

    remove

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

    Remove a user

    Parameters:
    event
    rc
    prc

    removePermission

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

    Remove permission to a author and gracefully end.

    Parameters:
    event
    rc
    prc
    Returns:
    json

    removePermissionGroup

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

    Remove permission to a author and gracefully end.

    Parameters:
    event
    rc
    prc
    Returns:
    json

    save

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

    Save user

    Parameters:
    event
    rc
    prc

    savePermission

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

    Save permission to the author and gracefully end.

    Parameters:
    event
    rc
    prc

    savePermissionGroup

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

    Save permission groups to the author and gracefully end.

    Parameters:
    event
    rc
    prc
    Returns:
    json

    savePreferences

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

    Save user preferences from the built UI from them

    Parameters:
    event
    rc
    prc

    saveRawPreferences

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

    Save raw preferences

    Parameters:
    event
    rc
    prc

    saveSinglePreference

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

    Save a user preference usually called asynchronously

    Parameters:
    event
    rc
    prc

    usernameCheck

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

    System username checks

    Parameters:
    event
    rc
    prc
    Returns:
    json