Class

ApiClient

ApiClient()

Client which access the admin API. Use it to fetch data from auto generated AdminBro API.

In the backend it uses axios client library.

Usage:

import { ApiClient } from 'admin-bro'

const api = new ApiClient()
// fetching all records
api.resourceAction({ resourceId: 'Comments', actionName: 'list' }).then(results => {...})

Methods

# async bulkAction(options) → {Promise.<BulkActionResponse>}

Invokes given bulk Action on the backend.

Parameters:
Name Type Description
options BulkActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 130

response from an Action

Promise.<BulkActionResponse>

# async getDashboard(options) → {Promise.<any>}

Invokes dashboard handler.

Parameters:
Name Type Description
options AxiosRequestConfig

View Source admin-bro/src/frontend/utils/api-client.ts, line 151

response from the handler function defined in AdminBroOptions#dashboard

Promise.<any>

# async getPage(options) → {Promise.<any>}

Invokes handler function of given page and returns its response.

Parameters:
Name Type Description
options GetPageAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 163

response from the handler of given page defined in AdminBroOptions#pages

Promise.<any>

# async recordAction(options) → {Promise.<RecordActionResponse>}

Invokes given record Action on the backend.

Parameters:
Name Type Description
options RecordActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 113

response from an Action

Promise.<RecordActionResponse>

# async resourceAction(options) → {Promise.<ActionResponse>}

Invokes given resource Action on the backend.

Parameters:
Name Type Description
options ResourceActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 91

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

View Source admin-bro/src/frontend/utils/api-client.ts, line 76

Promise.<SearchResponse>

Type Definitions

object

# BulkActionAPIParams

Properties:
Name Type Description
... any

any property supported by AxiosRequestConfig

recordIds Array.<string>

id of a record taken from RecordJSON

resourceId string

id of a resource taken from ResourceJSON

actionName string

action name taken from ActionJSON

See:

View Source admin-bro/src/frontend/utils/api-client.ts, line 203

object

# GetPageAPIParams

Properties:
Name Type Description
... any

any property supported by AxiosRequestConfig

pageName string

Unique page name

View Source admin-bro/src/frontend/utils/api-client.ts, line 215

object

# RecordActionAPIParams

Properties:
Name Type Description
... any

any property supported by AxiosRequestConfig

recordId string

id of a record taken from RecordJSON

resourceId string

id of a resource taken from ResourceJSON

actionName string

action name taken from ActionJSON

View Source admin-bro/src/frontend/utils/api-client.ts, line 192

object

# ResourceActionAPIParams

Properties:
Name Type Attributes Description
... any

any property supported by AxiosRequestConfig

resourceId string

id of a resource taken from ResourceJSON

actionName string

action name taken from ActionJSON

query string <optional>

query string

View Source admin-bro/src/frontend/utils/api-client.ts, line 181