docs/output/Ext.data.JsonP.js

   1 Ext.data.JsonP.Ext_data_JsonP({
   2   "tagname": "class",
   3   "name": "Ext.data.JsonP",
   4   "doc": "<p>This class is used to create JSONP requests. JSONP is a mechanism that allows for making\nrequests for data cross domain. More information is available here:\nhttp://en.wikipedia.org/wiki/JSONP</p>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "abort",
  24       "member": "Ext.data.JsonP",
  25       "doc": "<p>Abort a request. If the request parameter is not specified all open requests will\nbe aborted.</p>\n",
  26       "params": [
  27         {
  28           "type": "Object/String",
  29           "name": "request",
  30           "doc": "<p>(Optional) The request to abort</p>\n",
  31           "optional": false
  32         }
  33       ],
  34       "return": {
  35         "type": "void",
  36         "doc": "\n"
  37       },
  38       "private": false,
  39       "static": false,
  40       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
  41       "linenr": 123,
  42       "html_filename": "JsonP.html",
  43       "href": "JsonP.html#Ext-data-JsonP-method-abort",
  44       "shortDoc": "<p>Abort a request. If the request parameter is not specified all open requests will\nbe aborted.</p>\n"
  45     },
  46     {
  47       "tagname": "method",
  48       "name": "request",
  49       "member": "Ext.data.JsonP",
  50       "doc": "<p>Makes a JSONP request.</p>\n",
  51       "params": [
  52         {
  53           "type": "Object",
  54           "name": "options",
  55           "doc": "<p>An object which may contain the following properties. Note that options will\ntake priority over any defaults that are specified in the class.</p>\n\n<ul>\n<li><b>url</b> : String <div class=\"sub-desc\">The URL to request.</div></li>\n<li><b>params</b> : Object (Optional)<div class=\"sub-desc\">An object containing a series of\nkey value pairs that will be sent along with the request.</div></li>\n<li><b>timeout</b> : Number (Optional) <div class=\"sub-desc\">See <a href=\"#/api/Ext.data.JsonP-property-timeout\" rel=\"Ext.data.JsonP-property-timeout\" class=\"docClass\">timeout</a></div></li>\n<li><b>callbackKey</b> : String (Optional) <div class=\"sub-desc\">See <a href=\"#/api/Ext.data.JsonP-property-callbackKey\" rel=\"Ext.data.JsonP-property-callbackKey\" class=\"docClass\">callbackKey</a></div></li>\n<li><b>disableCaching</b> : Boolean (Optional) <div class=\"sub-desc\">See <a href=\"#/api/Ext.data.JsonP-property-disableCaching\" rel=\"Ext.data.JsonP-property-disableCaching\" class=\"docClass\">disableCaching</a></div></li>\n<li><b>disableCachingParam</b> : String (Optional) <div class=\"sub-desc\">See <a href=\"#/api/Ext.data.JsonP-property-disableCachingParam\" rel=\"Ext.data.JsonP-property-disableCachingParam\" class=\"docClass\">disableCachingParam</a></div></li>\n<li><b>success</b> : Function (Optional) <div class=\"sub-desc\">A function to execute if the request succeeds.</div></li>\n<li><b>failure</b> : Function (Optional) <div class=\"sub-desc\">A function to execute if the request fails.</div></li>\n<li><b>callback</b> : Function (Optional) <div class=\"sub-desc\">A function to execute when the request \ncompletes, whether it is a success or failure.</div></li>\n<li><b>scope</b> : Object (Optional)<div class=\"sub-desc\">The scope in\nwhich to execute the callbacks: The \"this\" object for the callback function. Defaults to the browser window.</div></li>\n</ul>\n\n",
  56           "optional": false
  57         }
  58       ],
  59       "return": {
  60         "type": "Object",
  61         "doc": "<p>request An object containing the request details.</p>\n"
  62       },
  63       "private": false,
  64       "static": false,
  65       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
  66       "linenr": 52,
  67       "html_filename": "JsonP.html",
  68       "href": "JsonP.html#Ext-data-JsonP-method-request",
  69       "shortDoc": "<p>Makes a JSONP request.</p>\n"
  70     }
  71   ],
  72   "property": [
  73     {
  74       "tagname": "property",
  75       "name": "callbackKey",
  76       "member": "Ext.data.JsonP",
  77       "type": "String",
  78       "doc": "<p>Specifies the GET parameter that will be sent to the server containing the function name to be executed when\nthe request completes. Defaults to <tt>callback</tt>. Thus, a common request will be in the form of\nurl?callback=Ext.data.JsonP.callback1</p>\n",
  79       "private": false,
  80       "static": false,
  81       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
  82       "linenr": 43,
  83       "html_filename": "JsonP.html",
  84       "href": "JsonP.html#Ext-data-JsonP-property-callbackKey",
  85       "shortDoc": "Specifies the GET parameter that will be sent to the server containing the function name to be executed when\nthe requ..."
  86     },
  87     {
  88       "tagname": "property",
  89       "name": "disableCaching",
  90       "member": "Ext.data.JsonP",
  91       "type": "Boolean",
  92       "doc": "<p>True to add a unique cache-buster param to requests. Defaults to <tt>true</tt>.</p>\n",
  93       "private": false,
  94       "static": false,
  95       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
  96       "linenr": 29,
  97       "html_filename": "JsonP.html",
  98       "href": "JsonP.html#Ext-data-JsonP-property-disableCaching"
  99     },
 100     {
 101       "tagname": "property",
 102       "name": "disableCachingParam",
 103       "member": "Ext.data.JsonP",
 104       "type": "String",
 105       "doc": "<p>Change the parameter which is sent went disabling caching through a cache buster. Defaults to <tt>'_dc'</tt>.</p>\n",
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
 109       "linenr": 36,
 110       "html_filename": "JsonP.html",
 111       "href": "JsonP.html#Ext-data-JsonP-property-disableCachingParam"
 112     },
 113     {
 114       "tagname": "property",
 115       "name": "timeout",
 116       "member": "Ext.data.JsonP",
 117       "type": "Number",
 118       "doc": "<p>A default timeout for any JsonP requests. If the request has not completed in this time the\nfailure callback will be fired. The timeout is in ms. Defaults to <tt>30000</tt>.</p>\n",
 119       "private": false,
 120       "static": false,
 121       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
 122       "linenr": 21,
 123       "html_filename": "JsonP.html",
 124       "href": "JsonP.html#Ext-data-JsonP-property-timeout",
 125       "shortDoc": "A default timeout for any JsonP requests. If the request has not completed in this time the\nfailure callback will be ..."
 126     }
 127   ],
 128   "event": [
 129
 130   ],
 131   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/JsonP.js",
 132   "linenr": 1,
 133   "html_filename": "JsonP.html",
 134   "href": "JsonP.html#Ext-data-JsonP",
 135   "cssVar": [
 136
 137   ],
 138   "cssMixin": [
 139
 140   ],
 141   "component": false,
 142   "superclasses": [
 143
 144   ],
 145   "subclasses": [
 146
 147   ],
 148   "mixedInto": [
 149
 150   ],
 151   "allMixins": [
 152
 153   ]
 154 });