Description
This function lists information about reseller account's available styles.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Styles/list
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_reseller_styles = $cpanel->uapi(
'Styles', 'list'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_reseller_styles = $cpliveapi->uapi(
'Styles', 'list',
);
cPanel Template Toolkit
[% data = execute( 'Styles', 'list' ).data; %]
[% FOREACH q = data %]
<p>
<br>Name: [% q.name %]</br>
<br>Type: [% q.type %]</br>
<br>Display Name: [% q.display_name %]</br>
<br>Preview: [% q.preview %]</br>
</p>
[% END %]
Command Line
uapi --user=username Styles list
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
"transformed": 1
},
"data": [
{
"preview": 1,
"name": "basic",
"type": "default",
"display_name": "Basic"
},
{
"preview": 0,
"name": "example",
"type": "reseller",
"display_name": "Example"
},
{
"preview": 1,
"name": "another",
"type": "global",
"display_name": "Global Theme"
}
]
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
type
|
string
|
The style type.
|
- default
- global
- reseller
- user
|
default
|
|
name
|
string
|
The folder that contains the style.
|
A filename.
|
basic
|
|
preview
|
Boolean
|
Whether the style contains a preview image.
|
|
1
|
|
display_name
|
string
|
The style name.
|
A style name.
The style's directory name determines this name.
|
Basic
|
|
selected
|
Boolean
|
Whether the style is the current style.
|
- 1 — The current style.
- 0 — Not the current style.
|
1
|
|
default
|
Boolean
|
Whether the style is the default style.
|
- 1 — The default style.
- 0 — Not the default style.
|
1
|
