akasha

Class URLSearchParams

java.lang.Object

akasha.core.JsObject

akasha.URLSearchParams

All Implemented Interfaces:

JsIterable<URLSearchParams.Entry>

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

The URLSearchParams interface defines utility methods to work with the query string of a URL.

See Also:

URLSearchParams - MDN, URLSearchParams - URL

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String name, java.lang.String value) The append() method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.
void	delete(java.lang.String name) The delete() method of the URLSearchParams interface deletes the given search parameter and all its associated values, from the list of all search parameters.
JsIterator<URLSearchParams.Entry>	entries() The entries() method of the URLSearchParams interface returns an iterator allowing iteration through all key/value pairs contained in this object.
void	forEach(URLSearchParams.ForEachCallback callback) The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.
void	forEach(URLSearchParams.ForEachCallback2 callback) The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.
void	forEach(URLSearchParams.ForEachCallback3 callback) The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.
java.lang.String	get(java.lang.String name) The get() method of the URLSearchParams interface returns the first value associated to the given search parameter.
JsArray<java.lang.String>	getAll(java.lang.String name) The getAll() method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.
boolean	has(java.lang.String name) The has() method of the URLSearchParams interface returns a Boolean that indicates whether a parameter with the specified name exists.
JsIterator<java.lang.String>	keys() The keys() method of the URLSearchParams interface returns an iterator allowing iteration through all keys contained in this object.
void	set(java.lang.String name, java.lang.String value) The set() method of the URLSearchParams interface sets the value associated with a given search parameter to the given value.
void	sort() The URLSearchParams.sort() method sorts all key/value pairs contained in this object in place and returns undefined.
JsIterator<java.lang.String>	values() The values() method of the URLsearchParams interface returns an iterator allowing iteration 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, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, 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

URLSearchParams

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

The URLSearchParams() constructor creates and returns a new URLSearchParams object.

See Also:

URLSearchParams.URLSearchParams - MDN, URLSearchParams() - URL

URLSearchParams

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

The URLSearchParams() constructor creates and returns a new URLSearchParams object.

See Also:

URLSearchParams.URLSearchParams - MDN, URLSearchParams() - URL

URLSearchParams

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

The URLSearchParams() constructor creates and returns a new URLSearchParams object.

See Also:

URLSearchParams.URLSearchParams - MDN, URLSearchParams() - URL

URLSearchParams

public URLSearchParams(@Nonnull
                       java.lang.String init)

The URLSearchParams() constructor creates and returns a new URLSearchParams object.

See Also:

URLSearchParams.URLSearchParams - MDN, URLSearchParams() - URL

URLSearchParams

public URLSearchParams()

The URLSearchParams() constructor creates and returns a new URLSearchParams object.

See Also:

URLSearchParams.URLSearchParams - MDN, URLSearchParams() - URL

Method Detail

append

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

The append() method of the URLSearchParams interface appends a specified key/value pair as a new search parameter.

See Also:

URLSearchParams.append - MDN, append() - URL

delete

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

The delete() method of the URLSearchParams interface deletes the given search parameter and all its associated values, from the list of all search parameters.

See Also:

URLSearchParams.delete - MDN, delete() - URL

get

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

The get() method of the URLSearchParams interface returns the first value associated to the given search parameter.

See Also:

URLSearchParams.get - MDN, get() - URL

getAll

@Nonnull
public JsArray<java.lang.String> getAll(@Nonnull
                                                 java.lang.String name)

The getAll() method of the URLSearchParams interface returns all the values associated with a given search parameter as an array.

See Also:

URLSearchParams.getAll - MDN, getAll() - URL

has

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

The has() method of the URLSearchParams interface returns a Boolean that indicates whether a parameter with the specified name exists.

See Also:

URLSearchParams.has - MDN, has() - URL

set

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

The set() method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. If there were several matching values, this method deletes the others. If the search parameter doesn't exist, this method creates it.

See Also:

URLSearchParams.set - MDN, set() - URL

sort

public void sort()

The URLSearchParams.sort() method sorts all key/value pairs contained in this object in place and returns undefined. The sort order is according to unicode code points of the keys. This method uses a stable sorting algorithm (i.e. the relative order between key/value pairs with equal keys will be preserved).

See Also:

URLSearchParams.sort - MDN, sort() - URL

keys

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

The keys() method of the URLSearchParams interface returns an iterator allowing iteration through all keys contained in this object. The keys are USVString objects.

See Also:

URLSearchParams.keys - MDN, keys() (see "iterable") - URL

values

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

The values() method of the URLsearchParams interface returns an iterator allowing iteration through all values contained in this object. The values are USVString objects.

See Also:

URLSearchParams.values - MDN, values() (see "iterable") - URL

entries

@Nonnull
public JsIterator<URLSearchParams.Entry> entries()

The entries() method of the URLSearchParams interface returns an iterator allowing iteration through all key/value pairs contained in this object. The key and value of each pair are USVString objects.

See Also:

URLSearchParams.entries - MDN, entries() (see "iterable") - URL

forEach

public void forEach(@Nonnull
                    URLSearchParams.ForEachCallback callback)

The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.

See Also:

URLSearchParams.forEach - MDN, forEach() (see "iterable") - URL

forEach

public void forEach(@Nonnull
                    URLSearchParams.ForEachCallback2 callback)

The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.

See Also:

URLSearchParams.forEach - MDN, forEach() (see "iterable") - URL

forEach

public void forEach(@Nonnull
                    URLSearchParams.ForEachCallback3 callback)

The forEach() method of the URLSearchParams interface allows iteration through all values contained in this object via a callback function.

See Also:

URLSearchParams.forEach - MDN, forEach() (see "iterable") - URL