Demo Get Started Join the community
Tutorials
01. Installation instructions 02. Adding resources 03. Customize resources 04. Customize actions 05. Writing your own Components 06. Using AdminBro features 07. Customize dashboard 08. Role-Based Access Control 09. Internationalization (i18n) 11. Content Management System
API Design System Modules

Class

ActionDecorator

ActionDecorator(params)

Decorates an action

Constructor

# new ActionDecorator(params)

Parameters:
Name Type Description
params Object
action Action
resource BaseResource
admin AdminBro

current instance of AdminBro

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 20

Members

Action

# action

Original action object

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 32

Methods

# canInvokeAction(context) → {boolean}

Indicates if user can invoke given action

Parameters:
Name Type Description
context ActionContext

passed action context

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 188

when user cannot perform given action

ForbiddenError

true given user has rights to the action

boolean

# async handler(request, response, context) → {Promise.<any>}

Original handler wrapped with the hook before and after methods.

Parameters:
Name Type Description
request ActionRequest
response any
context ActionContext

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 43

Promise.<any>

# async invokeAfterHook(response, request, context) → {Promise.<ActionResponse>}

Invokes after action hooks if there are any

Parameters:
Name Type Description
response ActionResponse
request ActionRequest
context ActionContext

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 101

Promise.<ActionResponse>

# async invokeBeforeHook(request, context) → {Promise.<ActionRequest>}

Invokes before action hooks if there are any

Parameters:
Name Type Description
request ActionRequest
context ActionContext

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 62

Promise.<ActionRequest>

# async invokeHandler(request, response, context) → {Promise.<ActionResponse>}

Invokes action handler if there is any

Parameters:
Name Type Description
request ActionRequest
response any
context ActionContext

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 83

Promise.<ActionResponse>

# isAccessible(currentAdminopt, recordopt) → {Boolean}

Is action accessible

Parameters:
Name Type Attributes Description
currentAdmin CurrentAdmin <optional>

currently logged in admin user
record BaseRecord <optional>

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 177

Boolean

# isBulkType() → {Boolean}

Returns true when action can be performed on selected records

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 134

Boolean

# isRecordType() → {Boolean}

Returns true when action can be performed on a record

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 118

Boolean

# isResourceType() → {Boolean}

Returns true when action can be performed on an entire resource

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 126

Boolean

# isVisible(currentAdminopt, recordopt) → {Boolean}

Is action visible in the UI

Parameters:
Name Type Attributes Description
currentAdmin CurrentAdmin <optional>

currently logged in admin user
record BaseRecord <optional>

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 167

Boolean

# toJSON(currentAdminopt) → {ActionJSON}

Serializes action to JSON format

Parameters:
Name Type Attributes Description
currentAdmin CurrentAdmin <optional>

View Source admin-bro/src/backend/decorators/action-decorator.ts, line 232

serialized action

ActionJSON