jquery-mobile/experiments/api-viewer/docs/jQuery.post/index.html

<!DOCTYPE html>
<html lang='en'><head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1"><meta http-equiv='content-type' content='text/html; charset=UTF-8' /></head><body>
<div data-role="page">
        <div data-role="header">
				<h1>jQuery.post()</h1>
  				
</div>
<div data-role="content" data-theme="c" id="jQuery.post1">
<h2 class="jq-clearfix roundTop section-title">
<span class="name">jQuery.post( url, [ data ], [ success(data, textStatus, XMLHttpRequest) ], [ dataType ] )</span> <span class="returns">Returns: <a class="return" href="http://docs.jquery.com/Types#XMLHttpRequest">XMLHttpRequest</a></span>
</h2>
<div class="  entry-details">
<p class="desc"><strong>Description: </strong>Load data from the server using a HTTP POST request.</p>
<ul class="signatures"><li class="signature" id="jQuery.post-url-data-successdata, textStatus, XMLHttpRequest-dataType">
<h4 class="name">
<span class="versionAdded">version added: <a href="/category/version/1.0/">1.0</a></span>jQuery.post( url, [ data ], [ success(data, textStatus, XMLHttpRequest) ], [ dataType ] )</h4>
<p class="arguement"><strong>url</strong>A string containing the URL to which the request is sent.</p>
<p class="arguement"><strong>data</strong>A map or string that is sent to the server with the request.</p>
<p class="arguement"><strong>success(data, textStatus, XMLHttpRequest)</strong>A callback function that is executed if the request succeeds.</p>
<p class="arguement"><strong>dataType</strong>The type of data expected from the server.</p>
</li></ul>
<div class="longdesc">
<p>This is a shorthand Ajax function, which is equivalent to:</p>
<pre>$.ajax({
  type: 'POST',
  url: <em>url</em>,
  data: <em>data</em>,
  success: <em>success</em>
  dataType: <em>dataType</em>
});
</pre>
<p>The <code>success</code> callback function is passed the returned data, which will be an XML root element or a text string depending on the MIME type of the response. It is also passed the text status of the response.</p>
<p>As of jQuery 1.4, the <code>success</code> callback function is also passed the XMLHttpRequest object.</p>
<p>Most implementations will specify a success handler:</p>
<pre>$.post('ajax/test.html', function(data) {
  $('.result').html(data);
});
</pre>
<p>This example fetches the requested HTML snippet and inserts it on the page.</p>
<p>Pages fetched with <code>POST</code> are never cached, so the <code>cache</code> and <code>ifModified</code> options in <code><a href="/jQuery.ajaxSetup">jQuery.ajaxSetup()</a></code> have no effect on these requests.</p>
</div>
<h3>Examples:</h3>
<div id="entry-examples" class="entry-examples">
<div id="example-0">
<h4>Example: <span class="desc">Request the test.php page, but ignore the return results.</span>
</h4>
<pre><code class="example">$.post("test.php");</code></pre>
</div>
<div id="example-1">
<h4>Example: <span class="desc">Request the test.php page and send some additional data along (while still ignoring the return results).</span>
</h4>
<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" } );</code></pre>
</div>
<div id="example-2">
<h4>Example: <span class="desc">pass arrays of data to the server (while still ignoring the return results).</span>
</h4>
<pre><code class="example">$.post("test.php", { 'choices[]': ["Jon", "Susan"] });</code></pre>
</div>
<div id="example-3">
<h4>Example: <span class="desc">send form data using ajax requests</span>
</h4>
<pre><code class="example">$.post("test.php", $("#testform").serialize());</code></pre>
</div>
<div id="example-4">
<h4>Example: <span class="desc">Alert out the results from requesting test.php (HTML or XML, depending on what was returned).</span>
</h4>
<pre><code class="example">$.post("test.php", function(data){
   alert("Data Loaded: " + data);
 });</code></pre>
</div>
<div id="example-5">
<h4>Example: <span class="desc">Alert out the results from requesting test.php with an additional payload of data (HTML or XML, depending on what was returned).</span>
</h4>
<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" },
   function(data){
     alert("Data Loaded: " + data);
   });</code></pre>
</div>
<div id="example-6">
<h4>Example: <span class="desc">Gets the test.php page content, store it in a XMLHttpResponse object and applies the process() JavaScript function.</span>
</h4>
<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" },
   function(data){
     process(data);
   }, "xml");</code></pre>
</div>
<div id="example-7">
<h4>Example: <span class="desc">Gets the test.php page contents which has been returned in json format ()

</span>
</h4>
<pre><code class="example">$.post("test.php", { "func": "getNameAndTime" },
   function(data){
     alert(data.name); // John
     console.log(data.time); //  2pm
   }, "json");</code></pre>
</div>
</div>
</div>
</div>

				</div>

</body></html>
added a jQuery api viewer demo. NOTE: content is a modified version of the downloadable HTML from http://jqapi.com 2010-09-16 17:13:38 +00:00			`<!DOCTYPE html>`
set utf-8 2010-11-02 01:46:29 +00:00			`<html lang='en'><head>`
Added viewport meta elements to the markup of every template and removed the metaViewportContent option from code and docs. IE does not support generated viewport tags. 2011-02-18 20:00:18 +00:00			`<meta charset="utf-8">`
			`<meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1"><meta http-equiv='content-type' content='text/html; charset=UTF-8' /></head><body>`
Big update: In starting markup, pages should now be identified with the attribute data-role="page". This allows us to then add ui-page programatically, hiding all non-active pages, and apply ui-page-active to one page at a time to show it. mobile.js is updated to find pages by this attribute now, instead of ui-page class. fixes issue 32 2010-09-18 16:20:35 +00:00			`<div data-role="page">`
updated markup to use data-role attrs in place of classes for header/content/footer 2010-09-21 14:58:54 +00:00			`<div data-role="header">`
added a jQuery api viewer demo. NOTE: content is a modified version of the downloadable HTML from http://jqapi.com 2010-09-16 17:13:38 +00:00			`<h1>jQuery.post()</h1>`

			`</div>`
switched up padding and margins on content div. Now it will get 15px padding, unless its a fullscreen page. Inset listviews have no margin now, and regular listviews have -15px margins. Also, collapsibles now have no padding. Updated HTML to remove ui-body classes for content divs, to match these changes. Fixes #161 2010-10-12 19:50:28 +00:00			`<div data-role="content" data-theme="c" id="jQuery.post1">`
added a jQuery api viewer demo. NOTE: content is a modified version of the downloadable HTML from http://jqapi.com 2010-09-16 17:13:38 +00:00			`<h2 class="jq-clearfix roundTop section-title">`
			`<span class="name">jQuery.post( url, [ data ], [ success(data, textStatus, XMLHttpRequest) ], [ dataType ] )</span> <span class="returns">Returns: <a class="return" href="http://docs.jquery.com/Types#XMLHttpRequest">XMLHttpRequest</a></span>`
			`</h2>`
			`<div class=" entry-details">`
			`<p class="desc"><strong>Description: </strong>Load data from the server using a HTTP POST request.</p>`
			`<ul class="signatures"><li class="signature" id="jQuery.post-url-data-successdata, textStatus, XMLHttpRequest-dataType">`
			`<h4 class="name">`
			`<span class="versionAdded">version added: <a href="/category/version/1.0/">1.0</a></span>jQuery.post( url, [ data ], [ success(data, textStatus, XMLHttpRequest) ], [ dataType ] )</h4>`
			`<p class="arguement"><strong>url</strong>A string containing the URL to which the request is sent.</p>`
			`<p class="arguement"><strong>data</strong>A map or string that is sent to the server with the request.</p>`
			`<p class="arguement"><strong>success(data, textStatus, XMLHttpRequest)</strong>A callback function that is executed if the request succeeds.</p>`
			`<p class="arguement"><strong>dataType</strong>The type of data expected from the server.</p>`
			`</li></ul>`
			`<div class="longdesc">`
			`<p>This is a shorthand Ajax function, which is equivalent to:</p>`
			`<pre>$.ajax({`
			`type: 'POST',`
			`url: <em>url</em>,`
			`data: <em>data</em>,`
			`success: <em>success</em>`
			`dataType: <em>dataType</em>`
			`});`
			`</pre>`
			`<p>The <code>success</code> callback function is passed the returned data, which will be an XML root element or a text string depending on the MIME type of the response. It is also passed the text status of the response.</p>`
			`<p>As of jQuery 1.4, the <code>success</code> callback function is also passed the XMLHttpRequest object.</p>`
			`<p>Most implementations will specify a success handler:</p>`
			`<pre>$.post('ajax/test.html', function(data) {`
			`$('.result').html(data);`
			`});`
			`</pre>`
			`<p>This example fetches the requested HTML snippet and inserts it on the page.</p>`
			`<p>Pages fetched with <code>POST</code> are never cached, so the <code>cache</code> and <code>ifModified</code> options in <code><a href="/jQuery.ajaxSetup">jQuery.ajaxSetup()</a></code> have no effect on these requests.</p>`
			`</div>`
			`<h3>Examples:</h3>`
			`<div id="entry-examples" class="entry-examples">`
			`<div id="example-0">`
			`<h4>Example: <span class="desc">Request the test.php page, but ignore the return results.</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php");</code></pre>`
			`</div>`
			`<div id="example-1">`
			`<h4>Example: <span class="desc">Request the test.php page and send some additional data along (while still ignoring the return results).</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" } );</code></pre>`
			`</div>`
			`<div id="example-2">`
			`<h4>Example: <span class="desc">pass arrays of data to the server (while still ignoring the return results).</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", { 'choices[]': ["Jon", "Susan"] });</code></pre>`
			`</div>`
			`<div id="example-3">`
			`<h4>Example: <span class="desc">send form data using ajax requests</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", $("#testform").serialize());</code></pre>`
			`</div>`
			`<div id="example-4">`
			`<h4>Example: <span class="desc">Alert out the results from requesting test.php (HTML or XML, depending on what was returned).</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", function(data){`
			`alert("Data Loaded: " + data);`
			`});</code></pre>`
			`</div>`
			`<div id="example-5">`
			`<h4>Example: <span class="desc">Alert out the results from requesting test.php with an additional payload of data (HTML or XML, depending on what was returned).</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" },`
			`function(data){`
			`alert("Data Loaded: " + data);`
			`});</code></pre>`
			`</div>`
			`<div id="example-6">`
			`<h4>Example: <span class="desc">Gets the test.php page content, store it in a XMLHttpResponse object and applies the process() JavaScript function.</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", { name: "John", time: "2pm" },`
			`function(data){`
			`process(data);`
			`}, "xml");</code></pre>`
			`</div>`
			`<div id="example-7">`
			`<h4>Example: <span class="desc">Gets the test.php page contents which has been returned in json format ()`

			`</span>`
			`</h4>`
			`<pre><code class="example">$.post("test.php", { "func": "getNameAndTime" },`
			`function(data){`
			`alert(data.name); // John`
			`console.log(data.time); // 2pm`
			`}, "json");</code></pre>`
			`</div>`
			`</div>`
			`</div>`
			`</div>`

			`</div>`

			`</body></html>`