Description
This function lists the current dynamicui.conf
file's object types.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=listobjecttypes
LiveAPI PHP Class
$cpanel
=
new
CPANEL();
$list_dynamicui
=
$cpanel
->api2(
'Branding'
,
'listobjecttypes'
);
LiveAPI Perl Module
my
$cpliveapi
= Cpanel::LiveAPI->new();
my
$list_dynamicui
=
$cpliveapi
->api2(
'Branding'
,
'listobjecttypes'
,
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username Branding listobjecttypes
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "listobjecttypes",
"data": [
{
"type": "css"
},
{
"type": "html"
},
{
"type": "image"
}
],
"event": {
"result": 1
},
"module": "Branding"
}
}
Parameters
This function does not accept parameters.
Returns
Return
|
Type
|
Description
|
Possible values
|
Example
|
type
|
string
|
An object type.
|
An object type in the current dynamicui.conf file.
|
image
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|