Classes
Methods
# bulkActionUrl(options) → {string}
Returns bulkAction url
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
BulkActionParams
|
||
resourceId |
string
|
||
recordIds |
Array.<string>
|
<optional> |
|
actionName |
string
|
string
# bulkDeleteUrl(resourceId, recordIds, searchopt) → {string}
Returns url for a `bulkDelete` action in given Resource. Uses bulkActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
recordIds |
Array.<string>
|
separated by comma records |
|
search |
string
|
<optional> |
optional query string |
string
# deleteUrl(resourceId, recordId, searchopt) → {string}
Returns url for a `delete` action in given Resource. Uses recordActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
recordId |
string
|
id to the record |
|
search |
string
|
<optional> |
optional query string |
string
# editUrl(resourceId, recordId, searchopt) → {string}
Returns url for a `edit` action in given Resource. Uses recordActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
recordId |
string
|
id to the record |
|
search |
string
|
<optional> |
optional query string |
string
# listUrl(resourceId, searchopt) → {string}
Returns url for a `list` action in given Resource. Uses resourceActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
search |
string
|
<optional> |
optional query string |
string
# newUrl(resourceId, searchopt) → {string}
Returns url for a `new` action in given Resource. Uses resourceActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
search |
string
|
<optional> |
optional query 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 AdminJSOptions |
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 | Attributes | Description |
---|---|---|---|
options |
ResourceActionParams
|
||
resourceId |
string
|
||
actionName |
string
|
||
search |
string
|
<optional> |
optional query string |
string
# showUrl(resourceId, recordId, searchopt) → {string}
Returns url for a `show` action in given Resource. Uses recordActionUrl
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
id to the resource |
|
recordId |
string
|
id to the record |
|
search |
string
|
<optional> |
optional query string |
string
Type Definitions
object
# ActionParams
Base Params for a any function
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
resourceId |
string
|
Unique Resource ID |
|
actionName |
string
|
Action name |
|
search |
string
|
<optional> |
Optional query string: ?.... |
object
# BulkActionParams
Params for a bulk action
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
recordIds |
Array.<string>
|
<optional> |
Array of Records ID |
object
# RecordActionParams
Params for a record action
Properties:
Name | Type | Description |
---|---|---|
recordId |
string
|
Record ID |