X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/RemotingProvider.html diff --git a/docs/source/RemotingProvider.html b/docs/source/RemotingProvider.html index 4b65c661..0566fb4d 100644 --- a/docs/source/RemotingProvider.html +++ b/docs/source/RemotingProvider.html @@ -1,4 +1,21 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @class Ext.direct.RemotingProvider
  * @extends Ext.direct.JsonProvider
  * 
@@ -31,7 +48,7 @@ Ext.define('Ext.direct.RemotingProvider', {
    
     /* End Definitions */
    
-   /**
+   /**
      * @cfg {Object} actions
      * Object literal defining the server side actions and methods. For example, if
      * the Provider is configured with:
@@ -80,29 +97,29 @@ TestAction.multiply(
      * available as the <tt>result</tt> in the example above. 
      */
     
-    /**
+    /**
      * @cfg {String/Object} namespace
      * Namespace for the Remoting Provider (defaults to the browser global scope of <i>window</i>).
      * Explicitly specify the namespace Object, or specify a String to have a
      * {@link Ext#namespace namespace created} implicitly.
      */
     
-    /**
+    /**
      * @cfg {String} url
-     * <b>Required<b>. The url to connect to the {@link Ext.direct.Manager} server-side router. 
+     * <b>Required</b>. The url to connect to the {@link Ext.direct.Manager} server-side router. 
      */
     
-    /**
+    /**
      * @cfg {String} enableUrlEncode
      * Specify which param will hold the arguments for the method.
      * Defaults to <tt>'data'</tt>.
      */
     
-    /**
+    /**
      * @cfg {Number/Boolean} enableBuffer
      * <p><tt>true</tt> or <tt>false</tt> to enable or disable combining of method
      * calls. If a number is specified this is the amount of time in milliseconds
-     * to wait before sending a batched request (defaults to <tt>10</tt>).</p>
+     * to wait before sending a batched request.</p>
      * <br><p>Calls which are received within the specified timeframe will be
      * concatenated together and sent in a single request, optimizing the
      * application by reducing the amount of round trips that have to be made
@@ -110,15 +127,15 @@ TestAction.multiply(
      */
     enableBuffer: 10,
     
-    /**
+    /**
      * @cfg {Number} maxRetries
-     * Number of times to re-attempt delivery on failure of a call. Defaults to <tt>1</tt>.
+     * Number of times to re-attempt delivery on failure of a call.
      */
     maxRetries: 1,
     
-    /**
+    /**
      * @cfg {Number} timeout
-     * The timeout to use for each request. Defaults to <tt>undefined</tt>.
+     * The timeout to use for each request.
      */
     timeout: undefined,
     
@@ -126,7 +143,7 @@ TestAction.multiply(
         var me = this;
         me.callParent(arguments);
         me.addEvents(
-            /**
+            /**
              * @event beforecall
              * Fires immediately before the client-side sends off the RPC call.
              * By returning false from an event handler you can prevent the call from
@@ -136,7 +153,7 @@ TestAction.multiply(
              * @param {Object} meta The meta data
              */            
             'beforecall',            
-            /**
+            /**
              * @event call
              * Fires immediately after the request to the server-side is sent. This does
              * NOT fire after the response has come back from the call.
@@ -151,7 +168,7 @@ TestAction.multiply(
         me.callBuffer = [];
     },
     
-    /**
+    /**
      * Initialize the API
      * @private
      */
@@ -179,7 +196,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Create a handler function for a direct call.
      * @private
      * @param {String} action The action the call is for
@@ -236,7 +253,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Run any callbacks related to the transaction.
      * @private
      * @param {Ext.direct.Transaction} transaction The transaction
@@ -260,7 +277,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * React to the ajax request being completed
      * @private
      */
@@ -308,7 +325,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Get transaction from XHR options
      * @private
      * @param {Object} options The options sent to the Ajax request
@@ -318,7 +335,7 @@ TestAction.multiply(
         return options && options.tid ? Ext.direct.Manager.getTransaction(options.tid) : null;
     },
     
-    /**
+    /**
      * Configure a direct request
      * @private
      * @param {String} action The action being executed
@@ -348,7 +365,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Gets the Ajax call info for a transaction
      * @private
      * @param {Ext.direct.Transaction} transaction The transaction
@@ -364,7 +381,7 @@ TestAction.multiply(
         };
     },
     
-    /**
+    /**
      * Sends a request to the server
      * @private
      * @param {Object/Array} data The data to send
@@ -403,7 +420,7 @@ TestAction.multiply(
         Ext.Ajax.request(request);
     },
     
-    /**
+    /**
      * Add a new transaction to the queue
      * @private
      * @param {Ext.direct.Transaction} transaction The transaction
@@ -428,7 +445,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Combine any buffered requests and send them off
      * @private
      */
@@ -442,14 +459,14 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Configure a form submission request
      * @private
      * @param {String} action The action being executed
      * @param {Object} method The method being executed
      * @param {HTMLElement} form The form being submitted
      * @param {Function} callback (optional) A callback to run after the form submits
-     * @param {Object} scope A scope to execute the callback in
+     * @param {Object} scope (optional) A scope to execute the callback in
      */
     configureFormRequest : function(action, method, form, callback, scope){
         var me = this,
@@ -488,7 +505,7 @@ TestAction.multiply(
         }
     },
     
-    /**
+    /**
      * Sends a form request
      * @private
      * @param {Ext.direct.Transaction} transaction The transaction to send
@@ -506,4 +523,6 @@ TestAction.multiply(
     }
     
 });
-
\ No newline at end of file +
+ +