Methods
# bulkActionUrl(options) → {string}
Returns bulkAction url
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
BulkActionParams | ||
resourceId |
string | ||
recordIds |
string |
<optional> |
|
actionName |
string |
string
# pageUrl(pageName) → {string}
Returns URL for given page name
Parameters:
Name | Type | Description |
---|---|---|
pageName |
string | page name which is a unique key specified in AdminBroOptions |
string
# recordActionUrl(options) → {string}
Returns recordAction url
Parameters:
Name | Type | Description |
---|---|---|
options |
RecordActionParams | |
resourceId |
string | |
recordId |
string | |
actionName |
string |
string
# resourceActionUrl(options) → {string}
Returns resourceAction url
Parameters:
Name | Type | Description |
---|---|---|
options |
ResourceActionParams | |
resourceId |
string | |
actionName |
string |
string
Type Definitions
object
# BulkActionParams
Params for a bulk action
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string | Unique Resource ID |
|
actionName |
string | Action name |
|
recordIds |
Array.<string> |
<optional> |
Array of Records ID |
search |
string |
<optional> |
Optional query string: ?.... |
object
# RecordActionParams
Params for a record action
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string | Unique Resource ID |
|
actionName |
string | Action name |
|
recordId |
string | Record ID |
|
search |
string |
<optional> |
Optional query string: ?.... |
object
# ResourceActionParams
Params for a resource action
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string | Unique Resource ID |
|
actionName |
string | Action name |
|
search |
string |
<optional> |
Optional query string: ?.... |
object
# ResourceParams
Params for a resource list
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string | Unique Resource ID |
|
search |
string |
<optional> |
Action name |