Resource (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.core.Resource

Direct Known Subclasses:

IonResource
```
@JsType(isNative=true,
        namespace="Cesium",
        name="Resource")
public class Resource
extends Object
```
A resource that includes the location and any other parameters we need to retrieve it or create derived resources. It also provides the ability to retry requests.

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Resource.RetryCallback
A function that returns the value of the property.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Resource.RetryCallback` A function that returns the value of the property.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`hasHeaders` True if the Resource has request headers.
`JsObject`	`headers` Additional HTTP headers that will be sent with the request.
`boolean`	`isBlobUri` True if the Resource refers to a blob URI.
`boolean`	`isCrossOriginUrl` True if the Resource refers to a cross origin URL.
`boolean`	`isDataUri` True if the Resource refers to a data URI.
`DefaultProxy`	`proxy` A proxy to be used when loading the resource.
`Request`	`request` A Request object that will be used.
`int`	`retryAttempts` The number of times the retryCallback should be called before giving up.
`Resource.RetryCallback`	`retryCallback` Function to call when a request for this resource fails.
`JsObject`	`templateValues` The key/value pairs used to replace template parameters in the url.
`String`	`url` The url to the resource with template values replaced, query string appended and encoded by proxy if one was set.

Constructor Summary

Constructors
Constructor and Description

Resource(ResourceOptions options)

Constructors
Constructor and Description
`Resource(ResourceOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendForwardSlash()` Appends a forward slash to the URL.
`void`	`appendQueryParameters(JsObject params)` Combines the specified object and the existing query parameters.
`Resource`	`clone()` Duplicates a Resource instance.
`Resource`	`clone(Resource result)` Duplicates a Resource instance.
`static Resource`	`DEFAULT()` A resource instance initialized to the current browser location.
`static Promise<JsObject,Void>`	`delete(ResourceHttpOptions options)` Creates a Resource from a URL and calls delete() on it.
`static Promise<JsObject,Void>`	`delete(String url)` Creates a Resource from a URL and calls delete() on it.
`String`	`extension()` The file extension of the resource.
`static Promise<JsObject,Void>`	`fetch(ResourceHttpOptions options)` Creates a Resource from a URL and calls fetch() on it.
`static Promise<JsObject,Void>`	`fetch(String url)` Creates a Resource from a URL and calls fetch() on it.
`Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void>`	`fetchArrayBuffer()` Asynchronously loads the resource as raw binary data.
`static Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void>`	`fetchArrayBuffer(ResourceOptions options)` Creates a Resource and calls fetchArrayBuffer() on it.
`static Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void>`	`fetchArrayBuffer(String url)` Creates a Resource and calls fetchArrayBuffer() on it.
`static Promise<JsBlob,Void>`	`fetchBlob(ResourceOptions options)` Creates a Resource and calls fetchBlob() on it.
`static Promise<JsBlob,Void>`	`fetchBlob(String url)` Creates a Resource and calls fetchBlob() on it.
`Promise<JsImage,Void>`	`fetchImage()` Asynchronously loads the given image resource.
`Promise<JsImage,Void>`	`fetchImage(boolean preferBlob)` Asynchronously loads the given image resource.
`static Promise<JsImage,Void>`	`fetchImage(ResourceImageOptions options)` Creates a Resource and calls fetchImage() on it.
`static Promise<JsImage,Void>`	`fetchImage(String url)` Creates a Resource and calls fetchImage() on it.
`Promise<JsObject,Void>`	`fetchJson()` Asynchronously loads the given resource as JSON.
`static Promise<JsObject,Void>`	`fetchJson(ResourceOptions options)` Creates a Resource and calls fetchJson() on it.
`static Promise<JsObject,Void>`	`fetchJson(String url)` Creates a Resource and calls fetchJson() on it.
`Promise<JsObject,Void>`	`fetchJsonp()` Requests a resource using JSONP.
`static Promise<JsObject,Void>`	`fetchJsonp(ResourceJsonpOptions options)` Creates a Resource from a URL and calls fetchJsonp() on it.
`static Promise<JsObject,Void>`	`fetchJsonp(String url)` Creates a Resource from a URL and calls fetchJsonp() on it.
`Promise<JsObject,Void>`	`fetchJsonpCallback(String callbackParameterName)` Requests a resource using JSONP.
`Promise<String,Void>`	`fetchText()` Asynchronously loads the given resource as text.
`static Promise<JsObject,Void>`	`fetchText(ResourceOptions options)` Creates a Resource and calls fetchText() on it.
`static Promise<JsObject,Void>`	`fetchText(String url)` Creates a Resource and calls fetchText() on it.
`static Promise<JsObject,Void>`	`fetchXML(ResourceOptions options)` Creates a Resource and calls fetchXML() on it.
`static Promise<JsObject,Void>`	`fetchXML(String url)` Creates a Resource and calls fetchXML() on it.
`String`	`getBaseUri()` Returns the base path of the Resource.
`String`	`getBaseUri(boolean includeQuery)` Returns the base path of the Resource.
`Resource`	`getDerivedResource()` Returns a resource relative to the current instance.
`Resource`	`getDerivedResource(DerivedResourceOptions options)` Returns a resource relative to the current instance.
`String`	`getUrlComponent()` Returns the url, optional with the query string and processed by a proxy.
`String`	`getUrlComponent(boolean query)` Returns the url, optional with the query string and processed by a proxy.
`String`	`getUrlComponent(boolean query, boolean proxy)` Returns the url, optional with the query string and processed by a proxy.
`Promise<JsObject,Void>`	`head()` Asynchronously gets headers the given resource.
`Promise<JsObject,Void>`	`head(ResourceHttpOptions options)` Asynchronously gets headers the given resource.
`static boolean`	`isBlobSupported()` Returns true if blobs are supported.
`Promise<JsObject,Void>`	`options()` Asynchronously gets options the given resource.
`Promise<JsObject,Void>`	`options(ResourceHttpOptions options)` Asynchronously gets options the given resource.
`static Promise<JsObject,Void>`	`patch(ResourcePathOptions options)` Creates a Resource from a URL and calls patch() on it.
`static Promise<JsObject,Void>`	`patch(String url)` Creates a Resource from a URL and calls patch() on it.
`Promise<JsObject,Void>`	`post(JsObject data)` Asynchronously posts data the given resource.
`Promise<JsObject,Void>`	`post(JsObject data, ResourceHttpOptions options)` Asynchronously posts data the given resource.
`static Promise<JsObject,Void>`	`post(ResourceHttpOptions options)` Creates a Resource from a URL and calls fetch() on it.
`static Promise<JsObject,Void>`	`post(String url)` Creates a Resource from a URL and calls fetch() on it.
`static Promise<JsObject,Void>`	`put(ResourcePutOptions options)` Creates a Resource from a URL and calls put() on it.
`static Promise<JsObject,Void>`	`put(String url)` Creates a Resource from a URL and calls put() on it.
`JsObject`	`queryParameters()` Query parameters appended to the url.
`Promise<Boolean,Void>`	`retryOnError()` Called when a resource fails to load.
`Promise<Boolean,Void>`	`retryOnError(JsObject error)` Called when a resource fails to load.
`void`	`setQueryParameters(JsObject params)` Combines the specified object and the existing query parameters.
`void`	`setQueryParameters(JsObject params, boolean useAsDefault)` Combines the specified object and the existing query parameters.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - hasHeaders
```
@JsProperty
public boolean hasHeaders
```
    True if the Resource has request headers. This is equivalent to checking if the headers property has any keys.
  - headers
```
@JsProperty
public JsObject headers
```
    Additional HTTP headers that will be sent with the request.
  - isBlobUri
```
@JsProperty
public boolean isBlobUri
```
    True if the Resource refers to a blob URI.
  - isCrossOriginUrl
```
@JsProperty
public boolean isCrossOriginUrl
```
    True if the Resource refers to a cross origin URL.
  - isDataUri
```
@JsProperty
public boolean isDataUri
```
    True if the Resource refers to a data URI.
  - proxy
```
@JsProperty
public DefaultProxy proxy
```
    A proxy to be used when loading the resource.
  - request
```
@JsProperty
public Request request
```
    A Request object that will be used. Intended for internal use only.
  - retryAttempts
```
@JsProperty
public int retryAttempts
```
    The number of times the retryCallback should be called before giving up.
  - retryCallback
```
@JsProperty
public Resource.RetryCallback retryCallback
```
    Function to call when a request for this resource fails. If it returns true or a Promise that resolves to true, the request will be retried.
  - templateValues
```
@JsProperty
public JsObject templateValues
```
    The key/value pairs used to replace template parameters in the url.
  - url
```
@JsProperty
public String url
```
    The url to the resource with template values replaced, query string appended and encoded by proxy if one was set.
- Constructor Detail
  - Resource
```
@JsConstructor
public Resource(ResourceOptions options)
```
- Method Detail
  - DEFAULT
```
@JsProperty(name="DEFAULT")
public static Resource DEFAULT()
```
    A resource instance initialized to the current browser location.
  - isBlobSupported
```
@JsProperty(name="isBlobSupported")
public static boolean isBlobSupported()
```
    Returns true if blobs are supported.
  - extension
```
@JsProperty(name="extension")
public String extension()
```
    The file extension of the resource.
  - queryParameters
```
@JsProperty(name="queryParameters")
public JsObject queryParameters()
```
    Query parameters appended to the url.
  - delete
```
@JsMethod
public static Promise<JsObject,Void> delete(String url)
```
    Creates a Resource from a URL and calls delete() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - delete
```
@JsMethod
public static Promise<JsObject,Void> delete(ResourceHttpOptions options)
```
    Creates a Resource from a URL and calls delete() on it.
    
    Parameters:
    
    options - ResourceHttpOptions.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetch
```
@JsMethod
public static Promise<JsObject,Void> fetch(String url)
```
    Creates a Resource from a URL and calls fetch() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetch
```
@JsMethod
public static Promise<JsObject,Void> fetch(ResourceHttpOptions options)
```
    Creates a Resource from a URL and calls fetch() on it.
    
    Parameters:
    
    options - RequestOptions.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchArrayBuffer
```
@JsMethod
public static Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void> fetchArrayBuffer(String url)
```
    Creates a Resource and calls fetchArrayBuffer() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchArrayBuffer
```
@JsMethod
public static Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void> fetchArrayBuffer(ResourceOptions options)
```
    Creates a Resource and calls fetchArrayBuffer() on it.
    
    Parameters:
    
    options - RequestOptions.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchImage
```
@JsMethod
public static Promise<JsImage,Void> fetchImage(String url)
```
    Creates a Resource and calls fetchImage() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchImage
```
@JsMethod
public static Promise<JsImage,Void> fetchImage(ResourceImageOptions options)
```
    Creates a Resource and calls fetchImage() on it.
    
    Parameters:
    
    options - ResourceImageOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJson
```
@JsMethod
public static Promise<JsObject,Void> fetchJson(String url)
```
    Creates a Resource and calls fetchJson() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJson
```
@JsMethod
public static Promise<JsObject,Void> fetchJson(ResourceOptions options)
```
    Creates a Resource and calls fetchJson() on it.
    
    Parameters:
    
    options - RequestOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJsonp
```
@JsMethod
public static Promise<JsObject,Void> fetchJsonp(String url)
```
    Creates a Resource from a URL and calls fetchJsonp() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJsonp
```
@JsMethod
public static Promise<JsObject,Void> fetchJsonp(ResourceJsonpOptions options)
```
    Creates a Resource from a URL and calls fetchJsonp() on it.
    
    Parameters:
    
    options - ResourceJsonpOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchText
```
@JsMethod
public static Promise<JsObject,Void> fetchText(String url)
```
    Creates a Resource and calls fetchText() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchText
```
@JsMethod
public static Promise<JsObject,Void> fetchText(ResourceOptions options)
```
    Creates a Resource and calls fetchText() on it.
    
    Parameters:
    
    options - ResourceOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchXML
```
@JsMethod
public static Promise<JsObject,Void> fetchXML(String url)
```
    Creates a Resource and calls fetchXML() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchXML
```
@JsMethod
public static Promise<JsObject,Void> fetchXML(ResourceOptions options)
```
    Creates a Resource and calls fetchXML() on it.
    
    Parameters:
    
    options - ResourceOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - patch
```
@JsMethod
public static Promise<JsObject,Void> patch(String url)
```
    Creates a Resource from a URL and calls patch() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - patch
```
@JsMethod
public static Promise<JsObject,Void> patch(ResourcePathOptions options)
```
    Creates a Resource from a URL and calls patch() on it.
    
    Parameters:
    
    options - ResourcePathOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - post
```
@JsMethod
public static Promise<JsObject,Void> post(String url)
```
    Creates a Resource from a URL and calls fetch() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - post
```
@JsMethod
public static Promise<JsObject,Void> post(ResourceHttpOptions options)
```
    Creates a Resource from a URL and calls fetch() on it.
    
    Parameters:
    
    options - ResourceHttpOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - put
```
@JsMethod
public static Promise<JsObject,Void> put(String url)
```
    Creates a Resource from a URL and calls put() on it.
    
    Parameters:
    
    url - The url of the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - put
```
@JsMethod
public static Promise<JsObject,Void> put(ResourcePutOptions options)
```
    Creates a Resource from a URL and calls put() on it.
    
    Parameters:
    
    options - ResourcePutOptions opbject.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - appendForwardSlash
```
@JsMethod
public void appendForwardSlash()
```
    Appends a forward slash to the URL.
  - appendQueryParameters
```
@JsMethod
public void appendQueryParameters(JsObject params)
```
    Combines the specified object and the existing query parameters. This allows you to add many parameters at once, as opposed to adding them one at a time to the queryParameters property.
    
    Parameters:
    
    params - The query parameters
  - clone
```
@JsMethod
public Resource clone()
```
    Duplicates a Resource instance.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    The modified result parameter or a new Resource instance if one was not provided.
  - clone
```
@JsMethod
public Resource clone(Resource result)
```
    Duplicates a Resource instance.
    
    Parameters:
    
    result - The object onto which to store the result.
    
    Returns:
    
    The modified result parameter or a new Resource instance if one was not provided.
  - fetchArrayBuffer
```
@JsMethod
public Promise<com.google.gwt.typedarrays.shared.ArrayBuffer,Void> fetchArrayBuffer()
```
    Asynchronously loads the resource as raw binary data. Returns a promise that will resolve to an ArrayBuffer once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchBlob
```
@JsMethod
public static Promise<JsBlob,Void> fetchBlob(String url)
```
    Creates a Resource and calls fetchBlob() on it.
    
    Parameters:
    
    url - url
    
    Returns:
    
    resource
  - fetchBlob
```
@JsMethod
public static Promise<JsBlob,Void> fetchBlob(ResourceOptions options)
```
    Creates a Resource and calls fetchBlob() on it.
    
    Parameters:
    
    options - ResourceOptions
    
    Returns:
    
    resource
  - fetchImage
```
@JsMethod
public Promise<JsImage,Void> fetchImage()
```
    Asynchronously loads the given image resource. Returns a promise that will resolve to an Image once loaded, or reject if the image failed to load.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchImage
```
@JsMethod
public Promise<JsImage,Void> fetchImage(boolean preferBlob)
```
    Asynchronously loads the given image resource. Returns a promise that will resolve to an Image once loaded, or reject if the image failed to load.
    
    Parameters:
    
    preferBlob - If true, we will load the image via a blob.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJson
```
@JsMethod
public Promise<JsObject,Void> fetchJson()
```
    Asynchronously loads the given resource as JSON. Returns a promise that will resolve to a JSON object once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled. This function adds 'Accept: application/json,*\/*;q=0.01' to the request headers, if not already specified.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJsonp
```
@JsMethod
public Promise<JsObject,Void> fetchJsonp()
```
    Requests a resource using JSONP.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchJsonpCallback
```
@JsMethod(name="fetchJsonp")
public Promise<JsObject,Void> fetchJsonpCallback(String callbackParameterName)
```
    Requests a resource using JSONP.
    
    Parameters:
    
    callbackParameterName - The callback parameter name that the server expects.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - fetchText
```
@JsMethod
public Promise<String,Void> fetchText()
```
    Asynchronously loads the given resource as text. Returns a promise that will resolve to a String once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - getBaseUri
```
@JsMethod
public String getBaseUri()
```
    Returns the base path of the Resource.
    
    Returns:
    
    The base URI of the resource
  - getBaseUri
```
@JsMethod
public String getBaseUri(boolean includeQuery)
```
    Returns the base path of the Resource.
    
    Parameters:
    
    includeQuery - Whether or not to include the query string and fragment form the uri
    
    Returns:
    
    The base URI of the resource
  - getDerivedResource
```
@JsMethod
public Resource getDerivedResource()
```
    Returns a resource relative to the current instance. All properties remain the same as the current instance unless overridden in options.
    
    Returns:
    
    The resource derived from the current one.
  - getDerivedResource
```
@JsMethod
public Resource getDerivedResource(DerivedResourceOptions options)
```
    Returns a resource relative to the current instance. All properties remain the same as the current instance unless overridden in options.
    
    Parameters:
    
    options - ResourceOptions object.
    
    Returns:
    
    The resource derived from the current one.
  - getUrlComponent
```
@JsMethod
public String getUrlComponent()
```
    Returns the url, optional with the query string and processed by a proxy.
    
    Returns:
    
    The url with all the requested components.
  - getUrlComponent
```
@JsMethod
public String getUrlComponent(boolean query)
```
    Returns the url, optional with the query string and processed by a proxy.
    
    Parameters:
    
    query - If true, the query string is included.
    
    Returns:
    
    The url with all the requested components.
  - getUrlComponent
```
@JsMethod
public String getUrlComponent(boolean query,
                                        boolean proxy)
```
    Returns the url, optional with the query string and processed by a proxy.
    
    Parameters:
    
    query - If true, the query string is included.
    
    proxy - If true, the url is processed the proxy object if defined.
    
    Returns:
    
    The url with all the requested components.
  - head
```
@JsMethod
public Promise<JsObject,Void> head()
```
    Asynchronously gets headers the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
    
    See Also:
    
    Cross-Origin Resource Sharing, CommonJS Promises/A
  - head
```
@JsMethod
public Promise<JsObject,Void> head(ResourceHttpOptions options)
```
    Asynchronously gets headers the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Parameters:
    
    options - ResourceHttpOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
    
    See Also:
    
    Cross-Origin Resource Sharing, CommonJS Promises/A
  - options
```
@JsMethod
public Promise<JsObject,Void> options()
```
    Asynchronously gets options the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - options
```
@JsMethod
public Promise<JsObject,Void> options(ResourceHttpOptions options)
```
    Asynchronously gets options the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Parameters:
    
    options - ResourceHttpOptions object.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - post
```
@JsMethod
public Promise<JsObject,Void> post(JsObject data)
```
    Asynchronously posts data the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Parameters:
    
    data - Data that is posted with the resource.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - post
```
@JsMethod
public Promise<JsObject,Void> post(JsObject data,
                                             ResourceHttpOptions options)
```
    Asynchronously posts data the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load. The data is loaded using XMLHttpRequest, which means that in order to make requests to another origin, the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
    
    Parameters:
    
    data - Data that is posted with the resource.
    
    options - Object with the following properties: ResourceHttpOptions.
    
    Returns:
    
    a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority.
  - retryOnError
```
@JsMethod
public Promise<Boolean,Void> retryOnError()
```
    Called when a resource fails to load. This will call the retryCallback function if defined until retryAttempts is reached.
    
    Returns:
    
    A promise to a boolean, that if true will cause the resource request to be retried.
  - retryOnError
```
@JsMethod
public Promise<Boolean,Void> retryOnError(JsObject error)
```
    Called when a resource fails to load. This will call the retryCallback function if defined until retryAttempts is reached.
    
    Parameters:
    
    error - The error that was encountered.
    
    Returns:
    
    A promise to a boolean, that if true will cause the resource request to be retried.
  - setQueryParameters
```
@JsMethod
public void setQueryParameters(JsObject params)
```
    Combines the specified object and the existing query parameters. This allows you to add many parameters at once, as opposed to adding them one at a time to the queryParameters property. If a value is already set, it will be replaced with the new value.
    
    Parameters:
    
    params - The query parameters
  - setQueryParameters
```
@JsMethod
public void setQueryParameters(JsObject params,
                                         boolean useAsDefault)
```
    Combines the specified object and the existing query parameters. This allows you to add many parameters at once, as opposed to adding them one at a time to the queryParameters property. If a value is already set, it will be replaced with the new value.
    
    Parameters:
    
    params - The query parameters
    
    useAsDefault - If true the params will be used as the default values, so they will only be set if they are undefined.

Class Resource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hasHeaders

headers

isBlobUri

isCrossOriginUrl

isDataUri

proxy

request

retryAttempts

retryCallback

templateValues

url

Constructor Detail

Resource

Method Detail

DEFAULT

isBlobSupported

extension

queryParameters

delete

delete

fetch

fetch

fetchArrayBuffer

fetchArrayBuffer

fetchImage

fetchImage

fetchJson

fetchJson

fetchJsonp

fetchJsonp

fetchText

fetchText

fetchXML

fetchXML

patch

patch

post

post

put

put

appendForwardSlash

appendQueryParameters

clone

clone

fetchArrayBuffer

fetchBlob

fetchBlob

fetchImage

fetchImage

fetchJson

fetchJsonp

fetchJsonpCallback

fetchText

getBaseUri

getBaseUri

getDerivedResource

getDerivedResource

getUrlComponent

getUrlComponent

getUrlComponent

head

head

options

options

post

post

retryOnError

retryOnError

setQueryParameters

setQueryParameters