Methods
# async bulkAction(options) → {Promise.<BulkActionResponse>}
Invokes given bulk Action on the backend.
Parameters:
Name | Type | Description |
---|---|---|
options |
BulkActionAPIParams
|
response from an Action
Promise.<BulkActionResponse>
# async getDashboard(options) → {Promise.<AxiosResponse.<any>>}
Invokes dashboard handler.
Parameters:
Name | Type | Description |
---|---|---|
options |
AxiosRequestConfig
|
response from the handler function defined in AdminJSOptions#dashboard
Promise.<AxiosResponse.<any>>
# async getPage(options) → {Promise.<AxiosResponse.<any>>}
Invokes handler function of given page and returns its response.
Parameters:
Name | Type | Description |
---|---|---|
options |
GetPageAPIParams
|
response from the handler of given page defined in AdminJSOptions#pages
Promise.<AxiosResponse.<any>>
# async recordAction(options) → {Promise.<RecordActionResponse>}
Invokes given record Action on the backend.
Parameters:
Name | Type | Description |
---|---|---|
options |
RecordActionAPIParams
|
response from an Action
Promise.<RecordActionResponse>
# async resourceAction(options) → {Promise.<ActionResponse>}
Invokes given resource Action on the backend.
Parameters:
Name | Type | Description |
---|---|---|
options |
ResourceActionAPIParams
|
response from an Action
Promise.<ActionResponse>
# async searchRecords(options) → {Promise.<SearchResponse>}
Search by query string for records in a given resource.
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
|
resourceId |
String
|
id of a ResourceJSON |
query |
String
|
query string |
Promise.<SearchResponse>
Type Definitions
object
# ActionAPIParams
Extends AxiosRequestConfig
Properties:
Name | Type | Description |
---|---|---|
... |
any
|
any property supported by AxiosRequestConfig |
object
# BulkActionAPIParams
Extends ActionAPIParams
Properties:
Name | Type | Description |
---|---|---|
... |
any
|
any property supported by ActionAPIParams |
object
# GetPageAPIParams
Extends AxiosRequestConfig
Properties:
Name | Type | Description |
---|---|---|
... |
any
|
any property supported by AxiosRequestConfig |
pageName |
string
|
Unique page name |
object
# RecordActionAPIParams
Extends ActionAPIParams
Properties:
Name | Type | Description |
---|---|---|
... |
any
|
any property supported by ActionAPIParams |
object
# ResourceActionAPIParams
Extends ActionAPIParams
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
... |
any
|
any property supported by AxiosRequestConfig |
|
query |
string
|
<optional> |