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 16

Members

Action

# action

Original action object

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

Methods

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

Original handler wrapped with the hook before and after methods.

Parameters:
Name Type Description
request ActionRequest
response any
data ActionContext

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

Promise.<any>

# 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 114

Boolean

# isBulkType() → {Boolean}

Returns true when action can be performed on selected records

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

Boolean

# isRecordType() → {Boolean}

Returns true when action can be performed on a record

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

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 63

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 104

Boolean

# toJSON() → {ActionJSON}

Serializes action to JSON format

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

serialized action

ActionJSON