net.java.html.lib.angular.ng

Class IHttpProviderDefaults

java.lang.Object

net.java.html.lib.Objs

net.java.html.lib.angular.ng.IHttpProviderDefaults

Direct Known Subclasses:

IRequestShortcutConfig

public class IHttpProviderDefaults
extends Objs

Nested Class Summary

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields

Modifier and Type	Field and Description
Objs.Property<Object>	cache {boolean|Cache} If true, a default $http cache will be used to cache the GET request, otherwise if a cache instance built with $cacheFactory, this cache will be used for caching.
Objs.Property<IHttpRequestConfigHeaders>	headers Map of strings or functions which return strings representing HTTP headers to send to the server.
Objs.Property<Union.A2<String,Objs>>	paramSerializer A function used to the prepare string representation of request parameters (specified as an object).
Objs.Property<Union.A2<IHttpRequestTransformer,IHttpRequestTransformer[]>>	transformRequest Transform function or an array of such functions.
Objs.Property<Union.A2<IHttpResponseTransformer,IHttpResponseTransformer[]>>	transformResponse Transform function or an array of such functions.
Objs.Property<Boolean>	withCredentials whether to to set the withCredentials flag on the XHR object.
Objs.Property<String>	xsrfCookieName Name of cookie containing the XSRF token.
Objs.Property<String>	xsrfHeaderName Name of HTTP header to populate with the XSRF token.

Fields inherited from class net.java.html.lib.Objs

prototype

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IHttpProviderDefaults(Objs.Constructor<?> c, Object js)

Method Summary

Modifier and Type	Method and Description
static IHttpProviderDefaults	$as(Object obj)
IHttpRequestConfigHeaders	headers()
Boolean	withCredentials()
String	xsrfCookieName()
String	xsrfHeaderName()

Methods inherited from class net.java.html.lib.Objs

$as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

cache

public Objs.Property<Object> cache

{boolean|Cache} If true, a default $http cache will be used to cache the GET request, otherwise if a cache instance built with $cacheFactory, this cache will be used for caching.

transformRequest

public Objs.Property<Union.A2<IHttpRequestTransformer,IHttpRequestTransformer[]>> transformRequest

Transform function or an array of such functions. The transform function takes the http request body and headers and returns its transformed (typically serialized) version.

See Also:

https://docs.angularjs.org/api/ng/service/$http#transforming-requests-and-responses}

transformResponse

public Objs.Property<Union.A2<IHttpResponseTransformer,IHttpResponseTransformer[]>> transformResponse

Transform function or an array of such functions. The transform function takes the http response body and headers and returns its transformed (typically deserialized) version.

headers

public Objs.Property<IHttpRequestConfigHeaders> headers

Map of strings or functions which return strings representing HTTP headers to send to the server. If the return value of a function is null, the header will not be sent. The key of the map is the request verb in lower case. The "common" key applies to all requests.

See Also:

https://docs.angularjs.org/api/ng/service/$http#setting-http-headers}

xsrfHeaderName

public Objs.Property<String> xsrfHeaderName

Name of HTTP header to populate with the XSRF token.

xsrfCookieName

public Objs.Property<String> xsrfCookieName

Name of cookie containing the XSRF token.

withCredentials

public Objs.Property<Boolean> withCredentials

whether to to set the withCredentials flag on the XHR object. See [requests with credentials]https://developer.mozilla.org/en/http_access_control#section_5 for more information.

paramSerializer

public Objs.Property<Union.A2<String,Objs>> paramSerializer

A function used to the prepare string representation of request parameters (specified as an object). If specified as string, it is interpreted as a function registered with the $injector. Defaults to $httpParamSerializer.

Constructor Detail

IHttpProviderDefaults

protected IHttpProviderDefaults(Objs.Constructor<?> c,
                                Object js)

Method Detail

$as

public static IHttpProviderDefaults $as(Object obj)

headers

public IHttpRequestConfigHeaders headers()

xsrfHeaderName

public String xsrfHeaderName()

xsrfCookieName

public String xsrfCookieName()

withCredentials

public Boolean withCredentials()