Upgrade to ExtJS 3.3.1 - Released 11/30/2010

[extjs.git] / docs / source / Api.html
diff --git a/docs/source/Api.html b/docs/source/Api.html

index 3c9fbb6..ee0be55 100644 (file)
--- a/docs/source/Api.html
+++ b/docs/source/Api.html
@@ -1,15 +1,16 @@
  <html>
  <head>
+  <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>
  </head>
  <body  onload="prettyPrint();">
      <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
   */
  
  <div id="cls-Ext.data.Api"></div>/**
@@ -72,8 +73,7 @@ restActions : {
  
          <div id="method-Ext.data.Api-isAction"></div>/**
           * Returns true if supplied action-name is a valid API action defined in <code>{@link #actions}</code> constants
-         * @param {String} action
-         * @param {String[]}(Optional) List of available CRUD actions.  Pass in list when executing multiple times for efficiency.
+         * @param {String} action Action to test for availability.
           * @return {Boolean}
           */
          isAction : function(action) {
@@ -105,7 +105,7 @@ restActions : {
          <div id="method-Ext.data.Api-isValid"></div>/**
           * Returns true if the supplied API is valid; that is, check that all keys match defined actions
           * otherwise returns an array of mistakes.
-         * @return {String[]||true}
+         * @return {String[]|true}
           */
          isValid : function(api){
              var invalid = [];
@@ -176,7 +176,8 @@ new Ext.data.HttpProxy({
                  proxy.api[action] = proxy.api[action] || proxy.url || proxy.directFn;
                  if (typeof(proxy.api[action]) == 'string') {
                      proxy.api[action] = {
-                        url: proxy.api[action]
+                        url: proxy.api[action],
+                        method: (proxy.restful === true) ? Ext.data.Api.restActions[action] : undefined
                      };
                  }
              }
@@ -190,7 +191,8 @@ new Ext.data.HttpProxy({
          restify : function(proxy) {
              proxy.restful = true;
              for (var verb in this.restActions) {
-                proxy.api[this.actions[verb]].method = this.restActions[verb];
+                proxy.api[this.actions[verb]].method ||
+                    (proxy.api[this.actions[verb]].method = this.restActions[verb]);
              }
              // TODO: perhaps move this interceptor elsewhere?  like into DataProxy, perhaps?  Placed here
              // to satisfy initial 3.0 final release of REST features.
@@ -202,16 +204,18 @@ new Ext.data.HttpProxy({
                  });
  
                  switch (response.status) {
-                    case 200:   // standard 200 response, send control back to HttpProxy#onWrite
+                    case 200:   // standard 200 response, send control back to HttpProxy#onWrite by returning true from this intercepted #onWrite
                          return true;
                          break;
                      case 201:   // entity created but no response returned
-                        //res[reader.meta.successProperty] = true;
-                        res.success = true;
+                        if (Ext.isEmpty(res.raw.responseText)) {
+                          res.success = true;
+                        } else {
+                          //if the response contains data, treat it like a 200
+                          return true;
+                        }
                          break;
                      case 204:  // no-content.  Create a fake response.
-                        //res[reader.meta.successProperty] = true;
-                        //res[reader.meta.root] = null;
                          res.success = true;
                          res.data = null;
                          break;
@@ -219,13 +223,6 @@ new Ext.data.HttpProxy({
                          return true;
                          break;
                  }
-                /*
-                if (res[reader.meta.successProperty] === true) {
-                    this.fireEvent("write", this, action, res[reader.meta.root], res, rs, o.request.arg);
-                } else {
-                    this.fireEvent('exception', this, 'remote', action, o, res, rs);
-                }
-                */
                  if (res.success === true) {
                      this.fireEvent("write", this, action, res.data, res, rs, o.request.arg);
                  } else {
@@ -262,7 +259,7 @@ Ext.data.Response.prototype = {
          return this.success;
      },
      getStatus : function() {
-        return this.status
+        return this.status;
      },
      getRoot : function() {
          return this.root;
@@ -294,6 +291,6 @@ Ext.apply(Ext.data.Api.Error.prototype, {
  });
  
  
-</pre>
+</pre>    
  </body>
  </html>
 \ No newline at end of file