org.cesiumjs.cs.core.options

Class ResourceOptions

java.lang.Object

org.cesiumjs.cs.core.options.ResourceOptions

Direct Known Subclasses:

DerivedResourceOptions, ResourceImageOptions, ResourceJsonpOptions, ResourcePutOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ResourceOptions
extends Object

Options for Resource.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
JsObject	headers Additional HTTP headers that will be sent.
DefaultProxy	proxy A proxy to be used when loading the resource.
JsObject	queryParameters An object containing query parameters that will be sent when retrieving 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 The Function to call when a request for this resource fails.
JsObject	templateValues Key/Value pairs that are used to replace template values (eg.
String	url The url of the resource.

Method Summary

Modifier and Type	Method and Description
static ResourceOptions	create(String url) Create new instance of ResourceOptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

url

@JsProperty
public String url

The url of the resource.

queryParameters

@JsProperty
public JsObject queryParameters

An object containing query parameters that will be sent when retrieving the resource.

templateValues

@JsProperty
public JsObject templateValues

Key/Value pairs that are used to replace template values (eg. {x}).

headers

@JsProperty
public JsObject headers

Additional HTTP headers that will be sent.

proxy

@JsProperty
public DefaultProxy proxy

A proxy to be used when loading the resource.

retryCallback

@JsProperty
public Resource.RetryCallback retryCallback

The Function to call when a request for this resource fails. If it returns true, the request will be retried.

retryAttempts

@JsProperty
public int retryAttempts

The number of times the retryCallback should be called before giving up. Default: 0

request

@JsProperty
public Request request

A Request object that will be used. Intended for internal use only.

Method Detail

create

@JsOverlay
public static ResourceOptions create(String url)

Create new instance of ResourceOptions.

Parameters:

url - The url of the resource.

Returns:

new ResourceOptions instance.