Touch 2.0.2 Sencha Docs

Ext.data.Request

Hierarchy

Ext.Base
Ext.data.Request

Files

Simple class that represents a Request that will be made by any Ext.data.proxy.Server subclass. All this class does is standardize the representation of a Request as used by any ServerProxy subclass, it does not contain any actual logic or perform the request itself.

Available since: 1.1.0

Defined By

Config options

Ext.data.Request
view source
: String
The name of the action this Request represents. ...

The name of the action this Request represents. Usually one of 'create', 'read', 'update' or 'destroy'.

Available since: 1.1.0

Ext.data.Request
view source
: Objectprivate

Available since: 2.0.0

Ext.data.Request
view source
: Objectprivate

Available since: 2.0.0

Ext.data.Request
view source
: String

Some requests (like JsonP) want to send an additional key that contains the name of the callback function.

Some requests (like JsonP) want to send an additional key that contains the name of the callback function.

Available since: 2.0.0

Ext.data.Request
view source
: Objectprivate
The following two configurations are only used by Ext.data.proxy.Direct and are just for being able to retrieve them ...

The following two configurations are only used by Ext.data.proxy.Direct and are just for being able to retrieve them after the request comes back from the server.

Available since: 2.0.0

Wether or not to disable caching for this request. ...

Wether or not to disable caching for this request. Defaults to false.

Defaults to: false

Available since: 2.0.0

Ext.data.Request
view source
: Object
Some requests (like XMLHttpRequests) want to send additional server headers. ...

Some requests (like XMLHttpRequests) want to send additional server headers. This configuration can be set for those types of requests.

Defaults to: {}

Available since: 2.0.0

Ext.data.Request
view source
: Object

This is used by some write actions to attach data to the request without encoding it as a parameter.

This is used by some write actions to attach data to the request without encoding it as a parameter.

Available since: 2.0.0

JsonP requests return a handle that might be useful in the callback function.

JsonP requests return a handle that might be useful in the callback function.

Available since: 2.0.0

Ext.data.Request
view source
: String
The HTTP method to use on this Request. ...

The HTTP method to use on this Request. Should be one of 'GET', 'POST', 'PUT' or 'DELETE'.

Defaults to: 'GET'

Available since: 1.1.0

The operation this request belongs to.

The operation this request belongs to.

Available since: 2.0.0

Ext.data.Request
view source
: Object
HTTP request params. ...

HTTP request params. The Proxy and its Writer have access to and can modify this object.

Available since: 1.1.0

Ext.data.Request
view source
: String
Most oData feeds require basic HTTP authentication. ...

Most oData feeds require basic HTTP authentication. This configuration allows you to specify the password.

Available since: Touch 2.0.2

The proxy this request belongs to.

The proxy this request belongs to.

Available since: 2.0.0

Ext.data.Request
view source
: Objectprivate

Available since: 2.0.0

Ext.data.Request
view source
: Objectprivate

Available since: 2.0.0

Ext.data.Request
view source
: Numberprivate
...

Defaults to: 30000

Available since: 2.0.0

Ext.data.Request
view source
: String

The url to access on this Request.

The url to access on this Request.

Available since: 1.1.0

Ext.data.Request
view source
: String
Most oData feeds require basic HTTP authentication. ...

Most oData feeds require basic HTTP authentication. This configuration allows you to specify the username.

Available since: Touch 2.0.2

This field is necessary when using cross-origin resource sharing.

This field is necessary when using cross-origin resource sharing.

Available since: 2.0.0

Ext.data.Request
view source
: Object
This is used by some write actions to attach data to the request without encoding it as a parameter, but instead send...

This is used by some write actions to attach data to the request without encoding it as a parameter, but instead sending it as XML.

Available since: 2.0.0

Properties

Defined By

Instance properties

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); / dependentOL on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 2.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

Ext.data.Request
view source
new( [config] ) : Ext.data.Request
Creates the Request object. ...

Creates the Request object.

Available since: 1.1.0

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

    Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

    Call the original method that was previously overridden with override

    Ext.define('My.Cat', {
        constructor: function() {
            alert("I'm a cat!");
        }
    });
    
    My.Cat.override({
        constructor: function() {
            alert("I'm going to be a cat!");
    
            var instance = this.callOverridden();
    
            alert("Meeeeoooowwww");
    
            return instance;
        }
    });
    
    var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                              // alerts "I'm a cat!"
                              // alerts "Meeeeoooowwww"
    

    Available since: 2.0.0

    Parameters

    • args : Array/Arguments

      The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

    Returns

    • Object

      Returns the result of calling the overridden method

    Call the "parent" method of the current method. ...

    Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

     Ext.define('My.Base', {
         constructor: function (x) {
             this.x = x;
         },
    
         statics: {
             method: function (x) {
                 return x;
             }
         }
     });
    
     Ext.define('My.Derived', {
         extend: 'My.Base',
    
         constructor: function () {
             this.callParent([21]);
         }
     });
    
     var obj = new My.Derived();
    
     alert(obj.x);  // alerts 21
    

    This can be used with an override as follows:

     Ext.define('My.DerivedOverride', {
         override: 'My.Derived',
    
         constructor: function (x) {
             this.callParent([x*2]); // calls original My.Derived constructor
         }
     });
    
     var obj = new My.Derived();
    
     alert(obj.x);  // now alerts 42
    

    This also works with static methods.

     Ext.define('My.Derived2', {
         extend: 'My.Base',
    
         statics: {
             method: function (x) {
                 return this.callParent([x*2]); // calls My.Base.method
             }
         }
     });
    
     alert(My.Base.method(10);     // alerts 10
     alert(My.Derived2.method(10); // alerts 20
    

    Lastly, it also works with overridden static methods.

     Ext.define('My.Derived2Override', {
         override: 'My.Derived2',
    
         statics: {
             method: function (x) {
                 return this.callParent([x*2]); // calls My.Derived2.method
             }
         }
     });
    
     alert(My.Derived2.method(10); // now alerts 40
    

    Available since: 2.0.0

    Parameters

    • args : Array/Arguments

      The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

    Returns

    • Object

      Returns the result of calling the parent method

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of action. ...

    Returns the value of action.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of args. ...

    Returns the value of args.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of callback. ...

    Returns the value of callback.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of callbackKey. ...

    Returns the value of callbackKey.

    Available since: 2.0.0

    Returns

    ...

    Available since: 2.0.0

    Parameters

    ...

    Available since: 2.0.0

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of directFn. ...

    Returns the value of directFn.

    Available since: 2.0.0

    Returns

    Returns the value of disableCaching. ...

    Returns the value of disableCaching.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of headers. ...

    Returns the value of headers.

    Available since: 2.0.0

    Returns

    Returns the initial configuration passed to constructor. ...

    Returns the initial configuration passed to constructor.

    Available since: 2.0.0

    Parameters

    • name : String (optional)

      When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of jsonData. ...

    Returns the value of jsonData.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of method. ...

    Returns the value of method.

    Available since: 2.0.0

    Returns

    Returns the value of operation. ...

    Returns the value of operation.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of params. ...

    Returns the value of params.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of password. ...

    Returns the value of password.

    Available since: Touch 2.0.2

    Returns

    Returns the value of proxy. ...

    Returns the value of proxy.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of records. ...

    Returns the value of records.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of scope. ...

    Returns the value of scope.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Number
    Returns the value of timeout. ...

    Returns the value of timeout.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of url. ...

    Returns the value of url.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : String
    Returns the value of username. ...

    Returns the value of username.

    Available since: Touch 2.0.2

    Returns

    Returns the value of withCredentials. ...

    Returns the value of withCredentials.

    Available since: 2.0.0

    Returns

    Ext.data.Request
    view source
    ( ) : Object
    Returns the value of xmlData. ...

    Returns the value of xmlData.

    Available since: 2.0.0

    Returns

    ...

    Available since: 2.0.0

    Parameters

    ( instanceConfig ) : Objectchainableprotected
    Initialize configuration for this class. ...

    Initialize configuration for this class. a typical example:

    Ext.define('My.awesome.Class', {
        // The default config
        config: {
            name: 'Awesome',
            isAwesome: true
        },
    
        constructor: function(config) {
            this.initConfig(config);
        }
    });
    
    var awesome = new My.awesome.Class({
        name: 'Super Awesome'
    });
    
    alert(awesome.getName()); // 'Super Awesome'
    

    Available since: 2.0.0

    Parameters

    Returns

    • Object

      mixins The mixin prototypes as key - value pairs

    Fires

      ( names, callback, scope )private
      ...

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( action )
      Sets the value of action. ...

      Sets the value of action.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( args )
      Sets the value of args. ...

      Sets the value of args.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( callback )
      Sets the value of callback. ...

      Sets the value of callback.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( callbackKey )
      Sets the value of callbackKey. ...

      Sets the value of callbackKey.

      Available since: 2.0.0

      Parameters

      ( config, applyIfNotSet ) : Ext.Basechainableprivate
      ...

      Available since: 2.0.0

      Parameters

      Returns

      Ext.data.Request
      view source
      ( directFn )
      Sets the value of directFn. ...

      Sets the value of directFn.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( disableCaching )
      Sets the value of disableCaching. ...

      Sets the value of disableCaching.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( headers )
      Sets the value of headers. ...

      Sets the value of headers.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( jsonData )
      Sets the value of jsonData. ...

      Sets the value of jsonData.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( method )
      Sets the value of method. ...

      Sets the value of method.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( operation )
      Sets the value of operation. ...

      Sets the value of operation.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( params )
      Sets the value of params. ...

      Sets the value of params.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( password )
      Sets the value of password. ...

      Sets the value of password.

      Available since: Touch 2.0.2

      Parameters

      Ext.data.Request
      view source
      ( proxy )
      Sets the value of proxy. ...

      Sets the value of proxy.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( records )
      Sets the value of records. ...

      Sets the value of records.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( scope )
      Sets the value of scope. ...

      Sets the value of scope.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( timeout )
      Sets the value of timeout. ...

      Sets the value of timeout.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( url )
      Sets the value of url. ...

      Sets the value of url.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( username )
      Sets the value of username. ...

      Sets the value of username.

      Available since: Touch 2.0.2

      Parameters

      Ext.data.Request
      view source
      ( withCredentials )
      Sets the value of withCredentials. ...

      Sets the value of withCredentials.

      Available since: 2.0.0

      Parameters

      Ext.data.Request
      view source
      ( xmlData )
      Sets the value of xmlData. ...

      Sets the value of xmlData.

      Available since: 2.0.0

      Parameters

      Get the reference to the class from which this object was instantiated. ...

      Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

      Ext.define('My.Cat', {
          statics: {
              totalCreated: 0,
              speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
          },
      
          constructor: function() {
              var statics = this.statics();
      
              alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                              // equivalent to: My.Cat.speciesName
      
              alert(this.self.speciesName);   // dependent on 'this'
      
              statics.totalCreated++;
          },
      
          clone: function() {
              var cloned = new this.self;                      // dependent on 'this'
      
              cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
      
              return cloned;
          }
      });
      
      
      Ext.define('My.SnowLeopard', {
          extend: 'My.Cat',
      
          statics: {
              speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
          },
      
          constructor: function() {
              this.callParent();
          }
      });
      
      var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
      
      var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
      
      var clone = snowLeopard.clone();
      alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
      alert(clone.groupName);                 // alerts 'Cat'
      
      alert(My.Cat.totalCreated);             // alerts 3
      

      Available since: 2.0.0

      Returns

      Defined By

      Static methods

      ( config, fullMerge )privatestatic
      ...

      Available since: 2.0.0

      Parameters

      ( members )chainableprivatestatic
      ...

      Available since: 2.0.0

      Parameters

      ( name, member )chainableprivatestatic
      ...

      Available since: 2.0.0

      Parameters

      ( members )chainablestatic
      Add methods / properties to the prototype of this class. ...

      Add methods / properties to the prototype of this class.

      Ext.define('My.awesome.Cat', {
          constructor: function() {
              ...
          }
      });
      
       My.awesome.Cat.implement({
           meow: function() {
              alert('Meowww...');
           }
       });
      
       var kitty = new My.awesome.Cat;
       kitty.meow();
      

      Available since: 2.0.0

      Parameters

      ( members ) : Ext.Basechainablestatic
      Add / override static properties of this class. ...

      Add / override static properties of this class.

      Ext.define('My.cool.Class', {
          ...
      });
      
      My.cool.Class.addStatics({
          someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
          method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
          method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
      });
      

      Available since: 2.0.0

      Parameters

      Returns

      ( xtype )chainableprivatestatic
      ...

      Available since: 2.0.0

      Parameters

      ( fromClass, members ) : Ext.Basechainableprivatestatic
      Borrow another class' members to the prototype of this class. ...

      Borrow another class' members to the prototype of this class.

      Ext.define('Bank', {
          money: '$$$',
          printMoney: function() {
              alert('$$$$$$$');
          }
      });
      
      Ext.define('Thief', {
          ...
      });
      
      Thief.borrow(Bank, ['money', 'printMoney']);
      
      var steve = new Thief();
      
      alert(steve.money); // alerts '$$$'
      steve.printMoney(); // alerts '$$$$$$$'
      

      Available since: 2.0.0

      Parameters

      • fromClass : Ext.Base

        The class to borrow members from

      • members : Array/String

        The names of the members to borrow

      Returns

      ( args )privatestatic
      ...

      Available since: 2.0.0

      Parameters

      Create a new instance of this Class. ...

      Create a new instance of this Class.

      Ext.define('My.cool.Class', {
          ...
      });
      
      My.cool.Class.create({
          someConfig: true
      });
      

      All parameters are passed to the constructor of the class.

      Available since: 2.0.0

      Returns

      ( alias, origin )static
      Create aliases for existing prototype methods. ...

      Create aliases for existing prototype methods. Example:

      Ext.define('My.cool.Class', {
          method1: function() { ... },
          method2: function() { ... }
      });
      
      var test = new My.cool.Class();
      
      My.cool.Class.createAlias({
          method3: 'method1',
          method4: 'method2'
      });
      
      test.method3(); // test.method1()
      
      My.cool.Class.createAlias('method5', 'method3');
      
      test.method5(); // test.method3() -> test.method1()
      

      Available since: 2.0.0

      Parameters

      ( parent )privatestatic
      ...

      Available since: 2.0.0

      Parameters

      Get the current class' name in string format. ...

      Get the current class' name in string format.

      Ext.define('My.cool.Class', {
          constructor: function() {
              alert(this.self.getName()); // alerts 'My.cool.Class'
          }
      });
      
      My.cool.Class.getName(); // 'My.cool.Class'
      

      Available since: 2.0.0

      Returns

      ...

      Available since: 2.0.0

      ( name, mixinClass )privatestatic
      Used internally by the mixins pre-processor ...

      Used internally by the mixins pre-processor

      Available since: 2.0.0

      Parameters

      ( fn, scope )chainableprivatestatic
      ...

      Available since: 2.0.0

      Parameters

      ( members ) : Ext.Basechainabledeprecatedstatic
      Override members of this class. ...

      Override members of this class. Overridden methods can be invoked via callParent.

      Ext.define('My.Cat', {
          constructor: function() {
              alert("I'm a cat!");
          }
      });
      
      My.Cat.override({
          constructor: function() {
              alert("I'm going to be a cat!");
      
              var instance = this.callParent(arguments);
      
              alert("Meeeeoooowwww");
      
              return instance;
          }
      });
      
      var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                // alerts "I'm a cat!"
                                // alerts "Meeeeoooowwww"
      

      As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

      Ext.define('My.CatOverride', {
          override: 'My.Cat',
          constructor: function() {
              alert("I'm going to be a cat!");
      
              var instance = this.callParent(arguments);
      
              alert("Meeeeoooowwww");
      
              return instance;
          }
      });
      

      The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

      Available since: 2.0.0

      This method has been deprecated since 4.1.0

      Please use Ext.define instead

      Parameters

      • members : Object

        The properties to add to this class. This should be specified as an object literal containing one or more properties.

      Returns

      ...

      Available since: 2.0.0