Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.


item :  Object

The config object being added.


The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out private members also filters the API class navigation tree.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Web Application Manager 6.0.0


Sencha Web Application Manager Public Admin API

Sencha Web Application Manager Public Admin API is a REST based application program interface that provides a developer with programmatic access to administration interface, and could be used to help manage security, mobility, and app deployment in your environment.

Public Admin API: Overview and Technology

Sencha Web Application Manager Public Admin API is a REST based API, using HTTPS POST and a custom keyed-HMAC (Hash Message Authentication Code) for authentication.

Public Admin API is exposed as a list of Web Services, each of them provides a number of methods. These methods are used as a final endpoints.

When accessing Sencha Web Application Manager Public Admin API using REST, submit all your requests to using POST operation. Make sure your request has proper 'Date' HTTP header in RFC 1123 Time Format. The following items must be provided in JSON format in your request:

  • id - Contains a unique ID that you generate that will be returned in responce and can be used for request determination in case of async/bulk querying
  • auth - API Key, which could be obtained via administration application
  • service - Service to call
  • method - Method to call
  • params - Method parameters
  • signature - Request signature, which is calculated using your secret access key, which could be obtained via administration application

Request example:

Sample Code
  id : 1, 
  auth : '7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=', 
  service : 'org', 
  method : 'update', 
  params : { name : 'My org' }, 
  signature : 'qnR8UCqJggD55PohusaBNviGoOJ67HC6Btry4qXLVZc='

Given the above, HTTPS request will look like:

Sample Code
POST /json.rpc HTTP/1.1
Cache-Control: max-age=0,
Content-Type: application/json,
Date: Mon, 14 Jul 2014 23:23:57 GMT

{id:1,auth:'7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=',service:'org',method:'update',params:{name:'My org'},signature: 'qnR8UCqJggD55PohusaBNviGoOJ67HC6Btry4qXLVZc='}

Bulk requests are also supported, which means that you could send multiple API requests in single HTTPS POST request:

Sample Code
POST /json.rpc HTTP/1.1
Cache-Control: max-age=0,
Content-Type: application/json,
Date: Mon, 14 Jul 2014 23:23:57 GMT

[{id:1,auth:'7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=',service:'org',method:'update',params:{name:'My org'},signature: 'qnR8UCqJggD55PohusaBNviGoOJ67HC6Btry4qXLVZc='},{id:2,auth:'7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=',service:'org',method:'get',params:{},signature: 'hMpd0Iko1eq0mQhz4nXEu+jl4UGOTE29hlANLQv8R1A='}]

Authenticating Requests Using the Public Admin API

When accessing Sencha Web Application Manager Public Admin API, you must provide an API Key (auth) and request Signature. In order to calculate Signature, you first concatenate elements of the request to form a string. You then use your secret access key to calculate the HMAC of that string. Finally, you add this signature as a parameter of the request by using the syntax described in previous section.

API Key & API Secret can be obtained via administration application:

When the system receives an authenticated request, it fetches the secret access key that you claim to have and uses it in the same way to compute a signature for the message it received. It then compares the signature it calculated against the signature presented by the requester. If the two signatures match, the system concludes that the requester must have access to the secret access key and therefore acts with the authority of the principal to whom the key was issued. If the two signatures do not match, the request is dropped and the system responds with an error message.

Following are the general steps for request signing:

  • Concatenate specified elements in a strictly specified sequence: ApiKey, serviceName, methodName, minimized string of method params in JSON, value of HTTP date header used in request. Use "|" separator during concatenation.
  • Calculate HMAC SHA256 hash of result of concatenation
  • Append result hash as 'signature' param of request

Request signing example in node.js:

Sample Code
var crypto = require('crypto');

var request = {
  id : 1, 
  auth : '7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=', // This is your API Key 
  service : 'org', 
  method : 'update', 
  params : { name : 'My org' }
var date = new Date().toUTCString(); // Don't forget to use this date in 'Date' HTTP header during request
var string_to_sign = '7Uh4KVwqVcsXXmyty/KnIc/h8GBw40SdUU1wrH+3Hhw=|org|update|'+ JSON.stringify(request.params)+'|'+date;
request.signature = crypto.createHmac('sha256', API_SECRET_KEY).update(string_to_sign).digest('base64');

Public Admin API Response

Response is a JSON formatted string which contains results of execution of method in certain service which are specified in request. Response consists of:

  • id - Contains a unique ID of request
  • result - JSON formatted result of execution of request

Response example:

Sample Code
  "result": {
    "visits": 0,
    "users": 1,
    "groups": 0,
    "apps": 14,
    "devices": 0
  "id": 42

In case of bulk request response is an array:

Sample Code
  "result": [1,0],
  "id": 43
  "result": [0,0],
  "id": 44
  "result": {
    "total": 0,
    "items": []
  "id": 45

Public Admin API Error Response

When the Public Admin API returns error messages, it does so in JSON format as well. The following items are provided in error object:

  • id - Contains a unique ID of request
  • error - JSON formatted error object

Likewise, error object consists of:

  • code - Error code
  • message - Error message
  • param(not mandatory) - Request param which caused error
  • error (not mandatory) - Error name

Error response example:

Sample Code
  "error": {
    "param": "password",
    "code": -32001,
    "message": "Incorrect email or password, please try again"
  "id": 1

In addition to descriptive error text, error messages contain machine-parseable codes. While the text for an error message may change, the codes will stay the same. The following table describes the codes which may appear when working with the API:

-32001Invalid request parameter
-32002Invalid email validation token
-32003Expired email validation token
-32086Ivalid emails in invitation list
-32087UI customization is forbidden
-32088Import concurrency error
-32089Access to VPN is forbidden
-32090Advanced authentication is forbidden
-32091Max user qouta was reached
-32092Max app qouta was reached
-32093This device was remotely wiped by an administrator
-32094Max device quota was reached
-32095Authentication token expired
-32096Authentication token revoked
-32097This device was remotely blocked by an administrator
-32098Access for this user was revoked by an administrator
-32099User is not authorized to perform specified action

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Sencha Themer
IDE Plugins
Sencha Inspector
Sencha Fiddle

Sencha Test

2.0.0 EA 1.0.3



Sencha Themer

Sencha Themer


5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle