[Laszlo-checkins] r13686 - openlaszlo/trunk/WEB-INF/lps/lfc/data

[hqm@openlaszlo.org]

Author: hqm
Date: 2009-04-15 10:48:05 -0700 (Wed, 15 Apr 2009)
New Revision: 13686

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs
Log:
Change 20090414-hqm-Y by hqm at badtzmaru.home on 2009-04-14 16:16:14 EDT
    in /Users/hqm/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary:  add documentation for LzDataset.postbody attribute

New Features:

Bugs Fixed: LPP-3792

Technical Reviewer: 
QA Reviewer: (pending)
Doc Reviewer: ptw

Documentation:

Release Notes:

Details:
    
+ this displays the 'postbody' attribute in the reference guide page on LzDataset

+ still need to add something to the dguide

Tests:



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs	2009-04-15 17:07:22 UTC (rev 13685)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataset.lzs	2009-04-15 17:48:05 UTC (rev 13686)
@@ -166,7 +166,23 @@
 /** @access private */
 function $lzc$set_timeout (t:Number) :void { this.timeout = t; }
 
-/** @access private */
+/** Used to send a string as the entire body of a POST request.
+ *
+ * For a POST request, setting postbody to a non-null string value
+ * will send that string as the complete body of the POST request. In
+ * this case any other query parameters that have been set via
+ * setQueryParam dataset will be ignored.
+ *
+ * The behavior of a GET request with a non-null postbody is not
+ * defined.
+ *
+ * Note, the swf8 runtime is forced to XML-quote the postbody, due to
+ * limitations in the Flash 8 player API. This restriction is not
+ * present in later swf runtimes, or in the DHTML runtime.
+ *
+ * @lzxtype String
+ * @type String
+*/
 var postbody :String = null;
 
 /** @access private */