Module

ListAction

Returns selected Records in a list form

Implements:

View Source admin-bro/src/backend/actions/list-action.ts, line 7

Methods

# static handler() → {Promise.<ListActionResponse>}

Responsible for returning data for all records.

To invoke this action use ApiClient#recordAction

Implements:

View Source admin-bro/src/backend/actions/list-action.ts, line 29

records with metadata

Promise.<ListActionResponse>

Type Definitions

object

# ListActionResponse

Response returned by List action

Properties:
Name Type Description
records Array.<RecordJSON>

Paginated collection of records
meta object

Pagination metadata
page number
perPage number
direction 'asc' | 'desc'
sortBy string
total number

View Source admin-bro/src/backend/actions/list-action.ts, line 74