Object/Trait

org.querki.jquery

JQueryAjaxSettings

Related Docs: trait JQueryAjaxSettings | package jquery

Permalink

object JQueryAjaxSettings extends JQueryAjaxSettingsBuilder

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JQueryAjaxSettings
  2. JQueryAjaxSettingsBuilder
  3. JSOptionBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def _result: JQueryAjaxSettings

    Permalink
    Definition Classes
    JSOptionBuilder
  5. def accepts(v: Object): JQueryAjaxSettingsBuilder

    Permalink

    The content type sent in the request header that tells the server what kind of response it will accept in return.

    The content type sent in the request header that tells the server what kind of response it will accept in return.

    Definition Classes
    JQueryAjaxSettingsBuilder
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def async(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    By default, all requests are sent asynchronously (i.e.

    By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests and dataType: "jsonp" requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active. As of jQuery 1.8, the use of async: false with jqXHR ($.Deferred) is deprecated; you must use the success/error/complete callback options instead of the corresponding methods of the jqXHR object such as jqXHR.done() or the deprecated jqXHR.success().

    Definition Classes
    JQueryAjaxSettingsBuilder
  8. def beforeSend(v: Function1[JQueryXHR, Object]): JQueryAjaxSettingsBuilder

    Permalink

    A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent.

    A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings objects are passed as arguments. This is an Ajax Event. Returning false in the beforeSend function will cancel the request. As of jQuery 1.5, the beforeSend option will be called regardless of the type of request.

    Definition Classes
    JQueryAjaxSettingsBuilder
  9. def cache(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    If set to false, it will force requested pages not to be cached by the browser.

    If set to false, it will force requested pages not to be cached by the browser. Note: Setting cache to false will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}" to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a POST is made to a URL that has already been requested by a GET.

    Definition Classes
    JQueryAjaxSettingsBuilder
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def complete(v: Function1[JQueryXHR, String]): JQueryAjaxSettingsBuilder

    Permalink

    A function to be called when the request finishes (after success and error callbacks are executed).

    A function to be called when the request finishes (after success and error callbacks are executed). The function gets passed two arguments: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request ("success", "notmodified", "nocontent", "error", "timeout", "abort", or "parsererror"). As of jQuery 1.5, the complete setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.

    Definition Classes
    JQueryAjaxSettingsBuilder
  12. def contentType(v: String): JQueryAjaxSettingsBuilder

    Permalink
    Definition Classes
    JQueryAjaxSettingsBuilder
  13. def contentType(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    When sending data to the server, use this content type.

    When sending data to the server, use this content type. Default is "application/x-www-form-urlencoded; charset=UTF-8", which is fine for most cases. If you explicitly pass in a content-type to $.ajax(), then it is always sent to the server (even if no data is sent). As of jQuery 1.6 you can pass false to tell jQuery to not set any content type header. Note: The W3C XMLHttpRequest specification dictates that the charset is always UTF-8; specifying another charset will not force the browser to change the encoding. Note: For cross-domain requests, setting the content type to anything other than application/x-www-form-urlencoded, multipart/form-data, or text/plain will trigger the browser to send a preflight OPTIONS request to the server.

    Definition Classes
    JQueryAjaxSettingsBuilder
  14. def contents(v: Dictionary[RegExp]): JQueryAjaxSettingsBuilder

    Permalink

    An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type.

    An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type. (version added: 1.5)

    Definition Classes
    JQueryAjaxSettingsBuilder
  15. def context(v: Object): JQueryAjaxSettingsBuilder

    Permalink

    This object will be the context of all Ajax-related callbacks.

    This object will be the context of all Ajax-related callbacks. By default, the context is an object that represents the ajax settings used in the call ($.ajaxSettings merged with the settings passed to $.ajax).

    TBD: can this object be a more strongly-typed facade?

    Definition Classes
    JQueryAjaxSettingsBuilder
  16. def converters(v: Dictionary[Function1[String, String]]): JQueryAjaxSettingsBuilder

    Permalink

    An object containing dataType-to-dataType converters.

    An object containing dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response. (version added: 1.5)

    TBD: is the function signature correct?

    Definition Classes
    JQueryAjaxSettingsBuilder
  17. def crossDomain(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true.

    If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain. (version added: 1.5)

    Definition Classes
    JQueryAjaxSettingsBuilder
  18. def data(v: String): JQueryAjaxSettingsBuilder

    Permalink
    Definition Classes
    JQueryAjaxSettingsBuilder
  19. def data(v: Dictionary[Any]): JQueryAjaxSettingsBuilder

    Permalink

    Data to be sent to the server.

    Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See processData option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the traditional setting (described below).

    Definition Classes
    JQueryAjaxSettingsBuilder
  20. def dataFilter(v: Function2[String, String, Any]): JQueryAjaxSettingsBuilder

    Permalink

    A function to be used to handle the raw response data of XMLHttpRequest.

    A function to be used to handle the raw response data of XMLHttpRequest. This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two arguments: The raw data returned from the server and the 'dataType' parameter.

    Definition Classes
    JQueryAjaxSettingsBuilder
  21. def dataType(v: String): JQueryAjaxSettingsBuilder

    Permalink

    The type of data that you're expecting back from the server.

    The type of data that you're expecting back from the server. (See http://api.jquery.com/jQuery.ajax/ for full details.)

    Definition Classes
    JQueryAjaxSettingsBuilder
  22. val dict: OptMap

    Permalink
    Definition Classes
    JQueryAjaxSettingsBuilder → JSOptionBuilder
  23. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  25. def error(v: Function3[JQueryXHR, String, String, Any]): JQueryAjaxSettingsBuilder

    Permalink

    A function to be called if the request fails.

    A function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides null) are "timeout", "error", "abort", and "parsererror". When an HTTP error occurs, errorThrown receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." As of jQuery 1.5, the error setting can accept an array of functions. Each function will be called in turn. Note: This handler is not called for cross-domain script and cross-domain JSONP requests. This is an Ajax Event.

    Definition Classes
    JQueryAjaxSettingsBuilder
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def global(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    Whether to trigger global Ajax event handlers for this request.

    Whether to trigger global Ajax event handlers for this request. The default is true. Set to false to prevent the global handlers like ajaxStart or ajaxStop from being triggered. This can be used to control various Ajax Events.

    Definition Classes
    JQueryAjaxSettingsBuilder
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. def headers(v: Dictionary[String]): JQueryAjaxSettingsBuilder

    Permalink

    An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport.

    An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport. The header X-Requested-With: XMLHttpRequest is always added, but its default XMLHttpRequest value can be changed here. Values in the headers setting can also be overwritten from within the beforeSend function. (version added: 1.5)

    Definition Classes
    JQueryAjaxSettingsBuilder
  31. def ifModified(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    Allow the request to be successful only if the response has changed since the last request.

    Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is false, ignoring the header. In jQuery 1.4 this technique also checks the 'etag' specified by the server to catch unmodified data.

    Definition Classes
    JQueryAjaxSettingsBuilder
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. def isLocal(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    Allow the current environment to be recognized as "local," (e.g.

    Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default. The following protocols are currently recognized as local: file, *-extension, and widget. If the isLocal setting needs modification, it is recommended to do so once in the $.ajaxSetup() method. (version added: 1.5.1)

    Definition Classes
    JQueryAjaxSettingsBuilder
  34. def jsOpt(name: String, opt: Any): JQueryAjaxSettingsBuilder

    Permalink
    Definition Classes
    JSOptionBuilder
  35. def jsonp(v: String): JQueryAjaxSettingsBuilder

    Permalink

    Override the callback function name in a JSONP request.

    Override the callback function name in a JSONP request. This value will be used instead of 'callback' in the 'callback=?' part of the query string in the url. So {jsonp:'onJSONPLoad'} would result in 'onJSONPLoad=?' passed to the server. As of jQuery 1.5, setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation. In this case, you should also explicitly set the jsonpCallback setting. For example, { jsonp: false, jsonpCallback: "callbackName" }

    Definition Classes
    JQueryAjaxSettingsBuilder
  36. def jsonpCallback(v: Function0[String]): JQueryAjaxSettingsBuilder

    Permalink
    Definition Classes
    JQueryAjaxSettingsBuilder
  37. def jsonpCallback(v: String): JQueryAjaxSettingsBuilder

    Permalink

    Specify the callback function name for a JSONP request.

    Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. As of jQuery 1.5, you can also use a function for this setting, in which case the value of jsonpCallback is set to the return value of that function.

    Definition Classes
    JQueryAjaxSettingsBuilder
  38. def method(v: String): JQueryAjaxSettingsBuilder

    Permalink

    The HTTP method to use for the request (e.g.

    The HTTP method to use for the request (e.g. "POST", "GET", "PUT"). (version added: 1.9.0)

    Definition Classes
    JQueryAjaxSettingsBuilder
  39. def mimeType(v: String): JQueryAjaxSettingsBuilder

    Permalink

    A mime type to override the XHR mime type.

    A mime type to override the XHR mime type. (version added: 1.5.1)

    Definition Classes
    JQueryAjaxSettingsBuilder
  40. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  42. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. def password(v: String): JQueryAjaxSettingsBuilder

    Permalink

    A password to be used with XMLHttpRequest in response to an HTTP access authentication request.

    A password to be used with XMLHttpRequest in response to an HTTP access authentication request.

    Definition Classes
    JQueryAjaxSettingsBuilder
  44. def processData(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded".

    By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded". If you want to send a DOMDocument, or other non-processed data, set this option to false.

    Definition Classes
    JQueryAjaxSettingsBuilder
  45. def scriptCharset(v: String): JQueryAjaxSettingsBuilder

    Permalink

    Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type).

    Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type). Sets the charset attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script.

    Definition Classes
    JQueryAjaxSettingsBuilder
  46. def statusCode(v: Object): JQueryAjaxSettingsBuilder

    Permalink

    An object of numeric HTTP codes and functions to be called when the response has the corresponding code.

    An object of numeric HTTP codes and functions to be called when the response has the corresponding code.

    TBD: is there a way to specify that this Object is a Map[Int, js.Function]?

    Definition Classes
    JQueryAjaxSettingsBuilder
  47. def success(v: Array[Function3[Any, String, JQueryXHR, Any]]): JQueryAjaxSettingsBuilder

    Permalink
    Definition Classes
    JQueryAjaxSettingsBuilder
  48. def success(v: Function3[Any, String, JQueryXHR, Any]): JQueryAjaxSettingsBuilder

    Permalink

    A function to be called if the request succeeds.

    A function to be called if the request succeeds. The function gets passed three arguments: The data returned from the server, formatted according to the dataType parameter or the dataFilter callback function, if specified; a string describing the status; and the jqXHR (in jQuery 1.4.x, XMLHttpRequest) object. As of jQuery 1.5, the success setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event.

    Definition Classes
    JQueryAjaxSettingsBuilder
  49. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  50. def timeout(v: Int): JQueryAjaxSettingsBuilder

    Permalink

    Set a timeout (in milliseconds) for the request.

    Set a timeout (in milliseconds) for the request. This will override any global timeout set with $.ajaxSetup(). The timeout period starts at the point the $.ajax call is made; if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent. In jQuery 1.4.x and below, the XMLHttpRequest object will be in an invalid state if the request times out; accessing any object members may throw an exception. In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period.

    Definition Classes
    JQueryAjaxSettingsBuilder
  51. def toString(): String

    Permalink
    Definition Classes
    JSOptionBuilder → AnyRef → Any
  52. def traditional(v: Boolean): JQueryAjaxSettingsBuilder

    Permalink

    Set this to true if you wish to use the traditional style of param serialization.

    Set this to true if you wish to use the traditional style of param serialization.

    Definition Classes
    JQueryAjaxSettingsBuilder
  53. def type(v: String): JQueryAjaxSettingsBuilder

    Permalink

    An alias for method.

    An alias for method. You should use type if you're using versions of jQuery prior to 1.9.0.

    Definition Classes
    JQueryAjaxSettingsBuilder
  54. def url(v: String): JQueryAjaxSettingsBuilder

    Permalink

    A string containing the URL to which the request is sent.

    A string containing the URL to which the request is sent.

    Definition Classes
    JQueryAjaxSettingsBuilder
  55. def username(v: String): JQueryAjaxSettingsBuilder

    Permalink

    A username to be used with XMLHttpRequest in response to an HTTP access authentication request.

    A username to be used with XMLHttpRequest in response to an HTTP access authentication request.

    Definition Classes
    JQueryAjaxSettingsBuilder
  56. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def xhrFields(v: Dictionary[Any]): JQueryAjaxSettingsBuilder

    Permalink

    An object of fieldName-fieldValue pairs to set on the native XHR object.

    An object of fieldName-fieldValue pairs to set on the native XHR object.

    Definition Classes
    JQueryAjaxSettingsBuilder

Inherited from JQueryAjaxSettingsBuilder

Inherited from JSOptionBuilder[JQueryAjaxSettings, JQueryAjaxSettingsBuilder]

Inherited from AnyRef

Inherited from Any

Ungrouped