cPanel API 2 Functions - Branding::spritelist - Knowledgebase

Description

This function lists sprite information and locations. Sprites store the cPanel interface's icons as a single image to conserve bandwidth.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Branding::spritelist — This function retrieves a sprite URL.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme.

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=gensprites&img=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List sprite information for the Getting Started Wizard.
$list_sprites = $cpanel->api2(
    'Branding', 'gensprites',
        array(      
            'img'           => 'getstart',
            'imgtype'       => 'icon',
            'method'        => 'skip_filetype_gif',
            'subtype'       => 'img',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List sprite information for the Getting Started Wizard.
my $list_sprites = $cpliveapi->api2(
    'Branding', 'gensprites',
    {
            'img'           => 'getstart',
            'imgtype'       => 'icon',
            'method'        => 'skip_filetype_gif',
            'subtype'       => 'img',
    }
 );

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "spritelist",
    "data": [
      {
        "images": [
           
        ],
        "spriteurl": "/cPanel_magic_revision_/"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Input	Type	Description	Possible values	Example
image	string	Set this parameter toheading to force output.	heading	heading
img	string	Required The image's branding object's name.	The name of a branding object, from thedynamicui.conf file.	getstart
imgtype	string	Required The image type.	If you use this parameter, you mustsupply a value of icon. The x3 theme does not support group images.	icon
method	string	Required The method to use to generate sprites.	only_filetype_gif — Generate sprites for .gif images only. skip_filetype_gif — Generate sprites for all images except for .gifimages. snap_to_smallest_width — Scale icons to the smallest possible width. scale_60percent — Scale icons to 60% of their size.	only_filetype_gif
skipgroups	boolean	Whether to return information for images that begin with group_. This value defaults to 0.	1 — Skip images that begin withgroup_. 0 — Include images that begin withgroup_. The x3 theme does not support group images.	0
subtype	string	Required The image subtype.	img bg compleximg	img

Returns

Return	Type	Description	Possible values	Example
images	string	The list of images.	One or more image names.
spriteurl	string	The sprite's path.	The sprite's path, relative to the user's home directory.	/cPanel_magic_revision/
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories