Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Request.html
index 6ed8dac..42fcd05 100644 (file)
@@ -1,52 +1,59 @@
+<!DOCTYPE html>
 <html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
 </head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.2
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-data-Request'>/**
+</span> * @author Ed Spencer
+ * 
+ * Simple class that represents a Request that will be made by any {@link 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.
  */
-<div id="cls-Ext.data.Request"></div>/**
- * @class Ext.data.Request
- * A simple Request class used internally to the data package to provide more generalized remote-requests
- * to a DataProxy.
- * TODO Not yet implemented.  Implement in Ext.data.Store#execute
- */
-Ext.data.Request = function(params) {
-    Ext.apply(this, params);
-};
-Ext.data.Request.prototype = {
-    <div id="cfg-Ext.data.Request-action"></div>/**
-     * @cfg {String} action
-     */
-    action : undefined,
-    <div id="cfg-Ext.data.Request-rs"></div>/**
-     * @cfg {Ext.data.Record[]/Ext.data.Record} rs The Store recordset associated with the request.
+Ext.define('Ext.data.Request', {
+<span id='Ext-data-Request-cfg-action'>    /**
+</span>     * @cfg {String} action
+     * The name of the action this Request represents. Usually one of 'create', 'read', 'update' or 'destroy'.
      */
-    rs : undefined,
-    <div id="cfg-Ext.data.Request-params"></div>/**
-     * @cfg {Object} params HTTP request params
+    action: undefined,
+    
+<span id='Ext-data-Request-cfg-params'>    /**
+</span>     * @cfg {Object} params
+     * HTTP request params. The Proxy and its Writer have access to and can modify this object.
      */
     params: undefined,
-    <div id="cfg-Ext.data.Request-callback"></div>/**
-     * @cfg {Function} callback The function to call when request is complete
+    
+<span id='Ext-data-Request-cfg-method'>    /**
+</span>     * @cfg {String} method
+     * The HTTP method to use on this Request. Should be one of 'GET', 'POST', 'PUT' or 'DELETE'.
      */
-    callback : Ext.emptyFn,
-    <div id="cfg-Ext.data.Request-scope"></div>/**
-     * @cfg {Object} scope The scope of the callback funtion
+    method: 'GET',
+    
+<span id='Ext-data-Request-cfg-url'>    /**
+</span>     * @cfg {String} url
+     * The url to access on this Request
      */
-    scope : undefined,
-    <div id="cfg-Ext.data.Request-reader"></div>/**
-     * @cfg {Ext.data.DataReader} reader The DataReader instance which will parse the received response
+    url: undefined,
+
+<span id='Ext-data-Request-method-constructor'>    /**
+</span>     * Creates the Request object.
+     * @param {Object} [config] Config object.
      */
-    reader : undefined
-};
-</pre>    
+    constructor: function(config) {
+        Ext.apply(this, config);
+    }
+});</pre>
 </body>
-</html>
\ No newline at end of file
+</html>