akasha

Class Headers

java.lang.Object

akasha.core.JsObject

akasha.Headers

All Implemented Interfaces:

JsIterable<Headers.Entry>

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Headers")
public class Headers
extends JsObject
implements JsIterable<Headers.Entry>

The Headers interface of the Fetch API allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing headers from the list of the request's headers.

See Also:

Headers - MDN, # headers-class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Headers.Entry
static interface	Headers.ForEachCallback
static interface	Headers.ForEachCallback2
static interface	Headers.ForEachCallback3

Constructor Summary

Constructors

Constructor and Description
Headers() The Headers() constructor creates a new Headers object.
Headers(HeadersInit init) The Headers() constructor creates a new Headers object.
Headers(JsArray<JsArray<java.lang.String>> init) The Headers() constructor creates a new Headers object.
Headers(JsArray<java.lang.String>[] init) The Headers() constructor creates a new Headers object.
Headers(jsinterop.base.JsPropertyMap<java.lang.String> init) The Headers() constructor creates a new Headers object.

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String name, java.lang.String value) The append() method of the Headers interface appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.
void	delete(java.lang.String name) The delete() method of the Headers interface deletes a header from the current Headers object.
@JsNonNull JsIterator<Headers.Entry>	entries() The Headers.entries() method returns an iterator allowing to go through all key/value pairs contained in this object.
void	forEach(@JsNonNull Headers.ForEachCallback callback)
void	forEach(@JsNonNull Headers.ForEachCallback2 callback)
void	forEach(@JsNonNull Headers.ForEachCallback3 callback)
@JsNullable java.lang.String	get(java.lang.String name) The get() method of the Headers interface returns a byte string of all the values of a header within a Headers object with a given name.
boolean	has(java.lang.String name) The has() method of the Headers interface returns a boolean stating whether a Headers object contains a certain header.
@JsNonNull JsIterator<java.lang.String>	keys() The Headers.keys() method returns an iterator allowing to go through all keys contained in this object.
void	set(java.lang.String name, java.lang.String value) The set() method of the Headers interface sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.
@JsNonNull JsIterator<java.lang.String>	values() The Headers.values() method returns an iterator allowing to go through all values contained in this object.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface akasha.lang.JsIterable

iterator

Constructor Detail

Headers

public Headers(@Nonnull
               HeadersInit init)

The Headers() constructor creates a new Headers object.

See Also:

Headers.Headers - MDN, Headers() - Fetch

Headers

public Headers(@Nonnull
               JsArray<JsArray<java.lang.String>> init)

The Headers() constructor creates a new Headers object.

See Also:

Headers.Headers - MDN, Headers() - Fetch

Headers

public Headers(@Nonnull
               jsinterop.base.JsPropertyMap<java.lang.String> init)

The Headers() constructor creates a new Headers object.

See Also:

Headers.Headers - MDN, Headers() - Fetch

Headers

public Headers(@Nonnull
               JsArray<java.lang.String>[] init)

The Headers() constructor creates a new Headers object.

See Also:

Headers.Headers - MDN, Headers() - Fetch

Headers

public Headers()

The Headers() constructor creates a new Headers object.

See Also:

Headers.Headers - MDN, Headers() - Fetch

Method Detail

append

public void append(@Nonnull
                   java.lang.String name,
                   @Nonnull
                   java.lang.String value)

The append() method of the Headers interface appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.

See Also:

Headers.append - MDN, append() - Fetch

delete

public void delete(@Nonnull
                   java.lang.String name)

The delete() method of the Headers interface deletes a header from the current Headers object.

See Also:

Headers.delete - MDN, delete() - Fetch

get

public @JsNullable java.lang.String get(@Nonnull
                                        java.lang.String name)

The get() method of the Headers interface returns a byte string of all the values of a header within a Headers object with a given name. If the requested header doesn't exist in the Headers object, it returns null.

See Also:

Headers.get - MDN, get() - Fetch

has

public boolean has(@Nonnull
                   java.lang.String name)

The has() method of the Headers interface returns a boolean stating whether a Headers object contains a certain header.

See Also:

Headers.has - MDN, has() - Fetch

set

public void set(@Nonnull
                java.lang.String name,
                @Nonnull
                java.lang.String value)

The set() method of the Headers interface sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.

See Also:

Headers.set - MDN, set() - Fetch

keys

public @JsNonNull JsIterator<java.lang.String> keys()

The Headers.keys() method returns an iterator allowing to go through all keys contained in this object. The keys are ByteString objects.

See Also:

Headers.keys - MDN

values

public @JsNonNull JsIterator<java.lang.String> values()

The Headers.values() method returns an iterator allowing to go through all values contained in this object. The values are ByteString objects.

See Also:

Headers.values - MDN

entries

public @JsNonNull JsIterator<Headers.Entry> entries()

The Headers.entries() method returns an iterator allowing to go through all key/value pairs contained in this object. The both the key and value of each pairs are ByteString objects.

See Also:

Headers.entries - MDN

forEach

public void forEach(@JsNonNull Headers.ForEachCallback callback)

forEach

public void forEach(@JsNonNull Headers.ForEachCallback2 callback)

forEach

public void forEach(@JsNonNull Headers.ForEachCallback3 callback)