Package: | Ext.data |
Defined In: | Api.js |
Class: | Api |
Extends: | Object |
Property | Defined By | |
---|---|---|
actions : Object Defined actions corresponding to remote actions:
actions: {
create : 'create', // Text representing the remote-... Defined actions corresponding to remote actions:
| Api | |
restActions : Object Defined {CRUD action}:{HTTP method} pairs to associate HTTP methods with the
corresponding actions for RESTful proxie... Defined {CRUD action}:{HTTP method} pairs to associate HTTP methods with the
corresponding actions for RESTful proxies.
Defaults to:
| Api |
Method | Defined By | |
---|---|---|
Response() : void Ext.data.Response
Experimental. Do not use directly. Ext.data.Response
Experimental. Do not use directly. Parameters:
| Api | |
getVerb( String name ) : String||null Returns the actual CRUD action KEY "create", "read", "update" or "destroy" from the supplied action-name. This metho... Returns the actual CRUD action KEY "create", "read", "update" or "destroy" from the supplied action-name. This method is used internally and shouldn't generally
need to be used directly. The key/value pair of Ext.data.Api.actions will often be identical but this is not necessarily true. A developer can override this naming
convention if desired. However, the framework internally calls methods based upon the KEY so a way of retreiving the the words "create", "read", "update" and "destroy" is
required. This method will cache discovered KEYS into the private validActions hash. Parameters:
| Api | |
hasUniqueUrl( Ext.data.DataProxy proxy, String verb ) : Boolean Returns true if the supplied verb upon the supplied proxy points to a unique url in that none of the other api-action... Returns true if the supplied verb upon the supplied proxy points to a unique url in that none of the other api-actions
point to the same url. The question is important for deciding whether to insert the "xaction" HTTP parameter within an
Ajax request. This method is used internally and shouldn't generally need to be called directly. Parameters:
| Api | |
isAction( String action ) : Boolean Returns true if supplied action-name is a valid API action defined in actions constants Returns true if supplied action-name is a valid API action defined in actions constantsParameters:
| Api | |
isValid() : String[]|true Returns true if the supplied API is valid; that is, check that all keys match defined actions
otherwise returns an ar... Returns true if the supplied API is valid; that is, check that all keys match defined actions
otherwise returns an array of mistakes. Parameters:
| Api | |
prepare( Ext.data.DataProxy proxy ) : void This method is used internally by DataProxy and should not generally need to be used directly.
Each action of a DataP... This method is used internally by DataProxy and should not generally need to be used directly.
Each action of a DataProxy api can be initially defined as either a String or an Object. When specified as an object,
one can explicitly define the HTTP method (GET|POST) to use for each CRUD action. This method will prepare the supplied API, setting
each action to the Object form. If your API-actions do not explicitly define the HTTP method, the "method" configuration-parameter will
be used. If the method configuration parameter is not specified, POST will be used.
Parameters:
| Api | |
restify( Ext.data.DataProxy proxy ) : void Prepares a supplied Proxy to be RESTful. Sets the HTTP method for each api-action to be one of
GET, POST, PUT, DELET... Prepares a supplied Proxy to be RESTful. Sets the HTTP method for each api-action to be one of
GET, POST, PUT, DELETE according to the defined restActions. Parameters:
| Api |