src/cm/media/js/lib/yui/yui_3.10.3/docs/jsonp/index.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
<!DOCTYPE html>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
<html lang="en">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
<head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
    <meta charset="utf-8">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
    <title>JSONP</title>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
    <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
    <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
    <link rel="stylesheet" href="../assets/css/main.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
    <script src="../../build/yui/yui-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
</head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
<body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
<!--
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
-->
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
<div id="doc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
    <div id="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
        <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
        <a href="#toc" class="jump">Jump to Table of Contents</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
            <h1>JSONP</h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
    <div class="yui3-g">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
        <div class="yui3-u-3-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
            <div id="main">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
                <div class="content"><div class="intro component">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
        <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
            The JSONP Utility is a specialized API for communicating with web
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
            services that provide JSON responses wrapped in a callback
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
            function.  A typical JSONP request URL might look like
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
            &quot;http://example.com/service.php?callback=handleData&quot; and
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
            receive a text response in the form of
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
            <code>handleData({"records":[....]});</code>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
        </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
        <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
            The nature of YUI 3's sandbox model complicates JSONP transactions
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
            because JSONP relies on a global access point to process the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
            response, but YUI 3 implementation code is typically wrapped in a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
            <code>use(...)</code> callback and is therefore not globally
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
            accessible.  The JSONP module provides a proxy system for
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
            channeling JSONP responses back into your YUI instance sandbox.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
        </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
        <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
            <strong>Security Note:</strong> JSONP is an inherently unsecure
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
            communication method, since it involves the transfer of unvalidated
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
            JavaScript.  It is by convention alone that the format is
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
            associated with JSON, but in reality, the response can include any
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
            arbitrary JavaScript, potentially opening your page to attack.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
            <em>Be cautious about which services you communicate with via
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
            JSONP</em>.  For safe JSON communication, use the <a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
            href="../json/index.html">JSON module</a> in
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
            conjunction with the <a
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
            href="../io/index.html">IO module</a> wherever
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
            possible.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
        </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
<h2 id="getting-started">Getting Started</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
To include the source files for JSONP and its dependencies, first load
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
the YUI seed file if you haven't already loaded it.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
<pre class="code prettyprint">&lt;script src=&quot;http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.10.3&#x2F;build&#x2F;yui&#x2F;yui-min.js&quot;&gt;&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
Next, create a new YUI instance for your application and populate it with the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
modules you need by specifying them as arguments to the <code>YUI().use()</code> method.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
YUI will automatically load any dependencies required by the modules you
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
specify.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
<pre class="code prettyprint">&lt;script&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
&#x2F;&#x2F; Create a new YUI instance and populate it with the required modules.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
YUI().use(&#x27;jsonp&#x27;, &#x27;jsonp-url&#x27;, function (Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
    &#x2F;&#x2F; JSONP is available and ready for use. Add implementation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
    &#x2F;&#x2F; code here.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
For more information on creating YUI instances and on the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
<a href="http://yuilibrary.com/yui/docs/api/classes/YUI.html#method_use"><code>use()</code> method</a>, see the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
documentation for the <a href="../yui/index.html">YUI Global Object</a>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
<h2 id="using">Using the JSONP Utility</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
<h3 id="basic">Instantiation and the <code>Y.jsonp</code> method</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
    The JSONP utility provides the <code>Y.jsonp(url, callback)</code> method
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
    for single transactions as well as a <code>Y.JSONPRequest</code> class to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
    manage reusable connections.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
    The first argument to either the <code>Y.jsonp</code> method or the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
    <code>Y.JSONPRequest</code> constructor is the URL of the JSONP service,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
    and the second is a callback function or <a href="#config">configuration
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
    object</a> that contains a callback function.  When the service responds
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
    with the data, the callback will be executed with the response data as the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
    first parameter.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
    In place of the JSONP callback name in the URL, include the string
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
    &quot;{callback}&quot;.  This placeholder will be used for a proxy function
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
    that will route the data to your callback.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
<pre class="code prettyprint">&#x2F;&#x2F; instead of service.php?callback=handleJSONP
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
var url = &quot;http:&#x2F;&#x2F;example.com&#x2F;service.php?callback={callback}&quot;;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
function handleJSONP(response) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
    &#x2F;&#x2F; response is a JavaScript object. No parsing necessary
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
    Y.one(&quot;#output&quot;).setHTML(response.outputHTML);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
Y.jsonp(url, handleJSONP);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
&#x2F;&#x2F; or
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
var service = new Y.JSONPRequest(url, handleJSONP);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
service.send();</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
<h4 id="timing">Sending JSONP requests</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
    <code>Y.jsonp(url, callback)</code> will dispatch the request immediately.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
    JSONPRequest instances will dispatch the request each time their
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
    <code>send()</code> method is called.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
<pre class="code prettyprint">&#x2F;&#x2F; request sent immediately
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
Y.jsonp(url, handleJSONP);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
&#x2F;&#x2F; No request sent
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
var service = new Y.JSONPRequest(url, handleJSONP);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
&#x2F;&#x2F; ...until now
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
service.send();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
&#x2F;&#x2F; ...and now again
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
service.send();</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
    <code>Y.jsonp(url, callback)</code> is a convenience wrapper to instantiate
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
    a JSONPRequest instance and call its <code>send()</code> method.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
    This will generate a request to a URL like this one (note that the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
    <code>{callback}</code> placeholder has been replaced with a dynamically
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
    generated callback name):
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
<pre class="code prettyprint">http:&#x2F;&#x2F;example.com&#x2F;service.php?callback=YUI.Env.JSONP.yui_3_3_0_1_1294184187597423</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
    The server will then be expected to respond with a JavaScript value wrapped
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
    in a call to that function, like this:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
<pre class="code prettyprint">YUI.Env.JSONP.yui_3_3_0_1_1294184187597423({&quot;foo&quot;:&quot;bar&quot;});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
<h3 id="config">Configuring the connection</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
    The second argument to either <code>Y.jsonp</code> or the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
    <code>Y.JSONPRequest</code> constructor can be a success callback function
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
    or for more control, it can be a configuration object.  The supported keys
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
    of this object are:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
<table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
    <thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
            <th>Property</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
            <th>Description</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
    </thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
    <tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
            <td>timeout</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
            <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
                This value, defined as milliseconds, is a time threshold for
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
                the transaction (e.g., <code>{ timeout: 2000 }</code> ). When
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
                this limit is reached, the transaction's
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
                <code>on.timeout</code> callback will be executed if
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
                supplied.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
            <td>context</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
            <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
                Defines what will be &quot;<code>this</code>&quot; in the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
                callbacks.  If undefined, the default will be the JSONPRequest
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
                instance.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
            <td>args</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
            <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
                An array of additional arguments that will be passed to the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
                callbacks as second, third, and so on arguments.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
            <td>on</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
            <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
                <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
                    <strong>Required</strong>. This object defines the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
                    callbacks to be used for the transaction.  At least an
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
                    <code>on.success</code> handler must be defined.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
                </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
                <ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
                    <li>success (<strong>required</strong>)</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
                    <li>failure</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
                    <li>timeout</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
                </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
            <td>format</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
            <td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
                Preprocessor function to stitch together the supplied URL
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
                (first argument), the proxy function name (internally
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
                generated), and any additional arguments passed to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
                <code>send()</code>.  See <a href="#format">Customizing the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
                JSONP URL</a> for more detail.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
    </tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
</table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
    This is an example of a configuration object, with a set of properties
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
    defined.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
<pre class="code prettyprint">var url     = &quot;http:&#x2F;&#x2F;example.com&#x2F;service.php?callback={callback}&quot;,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
    service = new Y.JSONPRequest(url, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
        on: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
            success: MyApp.handleJSONP,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
            timeout: MyApp.handleTimeout
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
        context: MyApp
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
        timeout: 3000,          &#x2F;&#x2F; 3 second timeout
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
        args: [new Date(), 100] &#x2F;&#x2F; e.g. handleJSONP(data, date, number)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
service.send();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
&#x2F;&#x2F; or
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
Y.jsonp(url, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
    on: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
        success: MyApp.handleJSONP,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
        timeout: MyApp.handleTimeout
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
    context: MyApp
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
    timeout: 3000,          &#x2F;&#x2F; 3 second timeout
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
    args: [new Date(), 100] &#x2F;&#x2F; e.g. handleJSONP(data, date, number)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
<h3 id="url">Parsing the callback from the URL</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
    An extension for the <code>jsonp</code> module is the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
    <code>jsonp-url</code> module which provides a few additional features.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
<ol>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
    <li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
        If you have a global function or a function available from the YUI
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
        instance (e.g. <code>Y.MyApp.handleJSONP</code>), you can include the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
        name in the URL and omit the second parameter entirely.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
    </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
    <li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
        The URL passed as the first parameter need not include the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
        &quot;{callback}&quot; string.  If it is not found, it will look for
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
        &quot;callback=&quot;, then fall back to adding the query parameter
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
        onto the URL.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
    </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
</ol>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
<pre class="code prettyprint">Y.MyApp.handleJSONP = function (data) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
    Y.one(&quot;#output&quot;).setHTML(data.outputHTML);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
Y.jsonp(&quot;http:&#x2F;&#x2F;example.com&#x2F;service.php?callback=Y.MyApp.handleJSONP&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
&#x2F;&#x2F; or
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
Y.jsonp(&quot;http:&#x2F;&#x2F;example.com&#x2F;service.php&quot;, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
    context: Y.MyApp,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
    on: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
        success: Y.MyApp.handleJSONP,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
        failure: Y.MyApp.handleFailure
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
<h3 id="format">Customizing the JSONP URL</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
    The default URL formatter simply replaces the &quot;{callback}&quot;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
    placehold with the name of the generated proxy function.  If you want to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
    customize the URL generation process, you can provide a <code>format</code>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
    function in the configuration.  The function will receive the configured
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
    URL (with &quot;{callback}&quot; placeholder), the string name of the proxy
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
    function, and any additional arguments that were passed to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
    <code>send()</code>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
<pre class="code prettyprint">&#x2F;&#x2F; Our custom formatter will expect a URL with an additional placeholder for
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
&#x2F;&#x2F; username that must be supplied in send(&quot;bill&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
&#x2F;&#x2F; e.g. http:&#x2F;&#x2F;example.com&#x2F;bill&#x2F;json?fn=YUI.Env.JSONP._12345
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
function prepareJSONPUrl(url, proxy, username) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
    return Y.Lang.sub(url, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
        callback: proxy,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
        name: username || &quot;user&quot;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
var url = &quot;http:&#x2F;&#x2F;example.com&#x2F;{name}&#x2F;json?fn={callback}&quot;;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   349
var service = new Y.JSONPRequest(url, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   350
        format: prepareJSONPUrl,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   351
        on: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   352
            success: handleJSONP
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   353
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   354
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   355
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   356
service.send(&quot;apipkin&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   357
service.send(&quot;tivac&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   358
service.send(&quot;razass&quot;);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   359
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   360
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   361
<h2 id="issues">Known Issues</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   362
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   363
<ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   364
    <li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   365
        Unlike the XMLHttpRequest calls generated by the IO utility, JSONP
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   366
        requests can't be aborted, since they rely on dynamic script insertion
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   367
        (which provides less low-level control than XHR). Keep this in mind
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   368
        when deciding which method to use.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   369
    </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   370
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   371
    <li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   372
        Since most browsers don't enforce execution order for dynamically
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   373
        inserted scripts, JSONP callbacks may not be called in the same order
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   374
        that the requests were sent. On the other hand, some browsers
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   375
        <em>do</em> enforce execution order, so in these browsers a slow
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   376
        request may block the execution of subsequent JSONP callbacks.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   377
    </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   378
    <li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   379
        In WinJS (Windows 8 application mode), JSONP is not supported
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   380
        due to the security measures enforced in that environment. Making 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   381
        a JSONP request requires a remote script tag which is prohibited.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   382
        An alternative is to use the YQL module to query a YQL table that
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   383
        can return the data that you need. The YQL module is supported in
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   384
        this environment because it uses native <code>XMLHttpRequest</code> to fetch it's data.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   385
    </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   386
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   387
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   388
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   389
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   390
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   391
        <div class="yui3-u-1-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   392
            <div class="sidebar">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   393
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   394
                    <div id="toc" class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   395
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   396
                            <h2 class="no-toc">Table of Contents</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   397
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   398
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   399
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   400
                            <ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   401
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   402
<a href="#getting-started">Getting Started</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   403
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   404
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   405
<a href="#using">Using the JSONP Utility</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   406
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   407
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   408
<a href="#basic">Instantiation and the <code>Y.jsonp</code> method</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   409
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   410
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   411
<a href="#timing">Sending JSONP requests</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   412
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   413
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   414
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   415
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   416
<a href="#config">Configuring the connection</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   417
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   418
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   419
<a href="#url">Parsing the callback from the URL</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   420
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   421
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   422
<a href="#format">Customizing the JSONP URL</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   423
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   424
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   425
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   426
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   427
<a href="#issues">Known Issues</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   428
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   429
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   430
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   431
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   432
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   433
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   434
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   435
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   436
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   437
                            <h2 class="no-toc">Examples</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   438
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   439
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   440
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   441
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   442
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   443
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   444
                                        <li data-description="Get basic GitHub user info using a Y.jsonp(url, callback).">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   445
                                            <a href="jsonp-github.html">Getting Cross Domain JSON Data Using Y.jsonp()</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   446
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   447
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   448
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   449
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   450
                                        <li data-description="Create a reusable JSONPRequest object to poll the YUILibrary.com Gallery web service, fetching info on a random Gallery module.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   451
                                            <a href="jsonp-gallery.html">Reusing a JSONPRequest Instance to Poll a Remote Server</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   452
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   453
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   454
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   455
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   456
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   457
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   458
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   459
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   460
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   461
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   462
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   463
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   464
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   465
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   466
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   467
                            <h2 class="no-toc">Examples That Use This Component</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   468
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   469
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   470
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   471
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   472
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   473
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   474
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   475
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   476
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   477
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   478
                                        <li data-description="Wrapping async transactions with promises">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   479
                                            <a href="../promise/basic-example.html">Wrapping async transactions with promises</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   480
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   481
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   482
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   483
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   484
                                        <li data-description="Extend Y.Promise to create classes that encapsulate standard transaction logic in descriptive method names">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   485
                                            <a href="../promise/subclass-example.html">Subclassing Y.Promise</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   486
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   487
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   488
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   489
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   490
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   491
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   492
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   493
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   494
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   495
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   496
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   497
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   498
<script src="../assets/vendor/prettify/prettify-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   499
<script>prettyPrint();</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   500
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   501
<script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   502
YUI.Env.Tests = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   503
    examples: [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   504
    project: '../assets',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   505
    assets: '../assets/jsonp',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   506
    name: 'jsonp',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   507
    title: 'JSONP',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   508
    newWindow: '',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   509
    auto:  false 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   510
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   511
YUI.Env.Tests.examples.push('jsonp-github');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   512
YUI.Env.Tests.examples.push('jsonp-gallery');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   513
YUI.Env.Tests.examples.push('basic-example');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   514
YUI.Env.Tests.examples.push('subclass-example');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   515
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   516
</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   517
<script src="../assets/yui/test-runner.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   518
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   519
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   520
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   521
</body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   522
</html>