goog.Uri.QueryData

Provided By	`goog.Uri.QueryData`

Class used to represent URI query parameters. It is essentially a hash of name-value pairs, though a name can be present more than once.

Has the same interface as the collections in goog.structs.

new QueryData( `opt_query`, `opt_ignoreCase` )

Parameters

`opt_query`	`(string\|null)=`
	Optional encoded query string to parse into the object.
`opt_ignoreCase`	`boolean=`
	If true, ignore the case of the parameter name in #get.

VIEW SOURCE

Instance Methods

Adds a key value pair.

Parameters

`key`	`string`
	Name.
`value`	`*`
	Value.

Returns

goog.Uri.QueryData

Instance of this object.

VIEW SOURCE

Clears the parameters.

VIEW SOURCE

Clone the query data instance.

Parameters

None.

Returns

goog.Uri.QueryData

New instance of the QueryData object.

VIEW SOURCE

Whether there is a parameter with the given name

Parameters

`key`	`string`
	The parameter name to check for.

Returns

boolean

Whether there is a parameter with the given name.

VIEW SOURCE

Whether there is a parameter with the given value.

Parameters

`value`	`*`
	The value to check for.

Returns

boolean

Whether there is a parameter with the given value.

VIEW SOURCE

Extends a query data object with another query data or map like object. This operates 'in-place', it does not create a new QueryData object.

Parameters

`var_args`	`...(Object\|null)`
	The object from which key value pairs will be copied. Note: does not accept null.

VIEW SOURCE

Removes all keys that are not in the provided list. (Modifies this object.)

Parameters

`keys`	`(Array<string>\|null)`
	The desired keys.

Returns

goog.Uri.QueryData

a reference to this object.

VIEW SOURCE

Runs a callback on every key-value pair in the map, including duplicate keys. This won't maintain original order when duplicate keys are interspersed (like getKeys() / getValues()).

Parameters

`f`	`function(?, string, goog.Uri.QueryData): ?`

`opt_scope`	`(SCOPE\|null)=`
	The value of "this" inside f.

VIEW SOURCE

Returns the first value associated with the key. If the query data has no such key this will return undefined or the optional default.

Parameters

`key`	`string`
	The name of the parameter to get the value for.
`opt_default`	`*=`
	The default value to return if the query data has no such key.

Returns

*

The first string value associated with the key, or opt_default if there's no value.

VIEW SOURCE

Parameters

None.

Returns

(number|null)

The number of parameters.

VIEW SOURCE

Returns all the keys of the parameters. If a key is used multiple times it will be included multiple times in the returned array

Parameters

None.

Returns

Array<string>

All the keys of the parameters.

VIEW SOURCE

Returns all the values of the parameters with the given name. If the query data has no such key this will return an empty array. If no key is given all values wil be returned.

Parameters

`opt_key`	`string=`
	The name of the parameter to get the values for.

Returns

Array<?>

All the values of the parameters with the given name.

VIEW SOURCE

Parameters

None.

Returns

boolean

Whether we have any parameters.

VIEW SOURCE

Removes all the params with the given key.

Parameters

`key`	`string`
	Name.

Returns

boolean

Whether any parameter was removed.

VIEW SOURCE

Sets a key value pair and removes all other keys with the same value.

Parameters

`key`	`string`
	Name.
`value`	`*`
	Value.

Returns

goog.Uri.QueryData

Instance of this object.

VIEW SOURCE

Ignore case in parameter names. NOTE: If there are already key/value pairs in the QueryData, and ignoreCase_ is set to false, the keys will all be lower-cased.

Parameters

`ignoreCase`	`boolean`
	whether this goog.Uri should ignore case.

VIEW SOURCE

Sets the values for a key. If the key already exists, this will override all of the existing values that correspond to the key.

Parameters

`key`	`string`
	The key to set values for.
`values`	`Array<?>`
	The values to set.

VIEW SOURCE

Parameters

None.

Returns

string

Decoded query string.

Throws

URIError If URI is malformed (that is, if decodeURIComponent fails on any of the URI components).

VIEW SOURCE

Parameters

None.

Returns

string

Encoded query string.

VIEW SOURCE

Static Functions

Creates a new query data instance from parallel arrays of parameter names and values. Allows for duplicate parameter names. Throws an error if the lengths of the arrays differ.

Parameters

`keys`	`Array<string>`
	Parameter names.
`values`	`Array<?>`
	Parameter values.
`opt_ignoreCase`	`boolean=`
	If true, ignore the case of the parameter name in #get.

Returns

goog.Uri.QueryData

The populated query data instance.

VIEW SOURCE

Creates a new query data instance from a map of names and values.

Parameters

`map`	`Object`
	Map of string parameter names to parameter value. If parameter value is an array, it is treated as if the key maps to each individual value in the array.
`opt_ignoreCase`	`boolean=`
	If true, ignore the case of the parameter name in #get.

Returns

goog.Uri.QueryData

The populated query data instance.

VIEW SOURCE

goog.Uri.QueryData

new QueryData( `opt_query`, `opt_ignoreCase` )

Instance Methods

`this.`add( `key`, `value` ) `→` `goog.Uri.QueryData`

`this.`clear() `→` `void`

`this.`clone() `→` `goog.Uri.QueryData`

`this.`containsKey( `key` ) `→` `boolean`

`this.`containsValue( `value` ) `→` `boolean`

`this.`extend( `...var_args` ) `→` `void`

`this.`filterKeys( `keys` ) `→` `goog.Uri.QueryData`

`this.`forEach`<SCOPE>`( `f`, `opt_scope` ) `→` `void`

`this.`get( `key`, `opt_default` ) `→` `*`

`this.`getCount() `→` `(number|null)`

`this.`getKeys() `→` `Array<string>`

`this.`getValues( `opt_key` ) `→` `Array<?>`

`this.`isEmpty() `→` `boolean`

`this.`remove( `key` ) `→` `boolean`

`this.`set( `key`, `value` ) `→` `goog.Uri.QueryData`

`this.`setIgnoreCase( `ignoreCase` ) `→` `void`

`this.`setValues( `key`, `values` ) `→` `void`

`this.`toDecodedString() `→` `string`

`this.`toString() `→` `string`

Static Functions

QueryData.createFromKeysValues( `keys`, `values`, `opt_ignoreCase` ) `→` `goog.Uri.QueryData`

QueryData.createFromMap( `map`, `opt_ignoreCase` ) `→` `goog.Uri.QueryData`

goog.Uri.QueryData

new QueryData( opt_query, opt_ignoreCase )

Instance Methods

this.add( key, value ) → goog.Uri.QueryData

this.clear() → void

this.clone() → goog.Uri.QueryData

this.containsKey( key ) → boolean

this.containsValue( value ) → boolean

this.extend( ...var_args ) → void

this.filterKeys( keys ) → goog.Uri.QueryData

this.forEach<SCOPE>( f, opt_scope ) → void

this.get( key, opt_default ) → *

this.getCount() → (number|null)

this.getKeys() → Array<string>

this.getValues( opt_key ) → Array<?>

this.isEmpty() → boolean

this.remove( key ) → boolean

this.set( key, value ) → goog.Uri.QueryData

this.setIgnoreCase( ignoreCase ) → void

this.setValues( key, values ) → void

this.toDecodedString() → string

this.toString() → string

Static Functions

QueryData.createFromKeysValues( keys, values, opt_ignoreCase ) → goog.Uri.QueryData

QueryData.createFromMap( map, opt_ignoreCase ) → goog.Uri.QueryData

new QueryData( `opt_query`, `opt_ignoreCase` )

`this.`add( `key`, `value` ) `→` `goog.Uri.QueryData`

`this.`clear() `→` `void`

`this.`clone() `→` `goog.Uri.QueryData`

`this.`containsKey( `key` ) `→` `boolean`

`this.`containsValue( `value` ) `→` `boolean`

`this.`extend( `...var_args` ) `→` `void`

`this.`filterKeys( `keys` ) `→` `goog.Uri.QueryData`

`this.`forEach`<SCOPE>`( `f`, `opt_scope` ) `→` `void`

`this.`get( `key`, `opt_default` ) `→` `*`

`this.`getCount() `→` `(number|null)`

`this.`getKeys() `→` `Array<string>`

`this.`getValues( `opt_key` ) `→` `Array<?>`

`this.`isEmpty() `→` `boolean`

`this.`remove( `key` ) `→` `boolean`

`this.`set( `key`, `value` ) `→` `goog.Uri.QueryData`

`this.`setIgnoreCase( `ignoreCase` ) `→` `void`

`this.`setValues( `key`, `values` ) `→` `void`

`this.`toDecodedString() `→` `string`

`this.`toString() `→` `string`

QueryData.createFromKeysValues( `keys`, `values`, `opt_ignoreCase` ) `→` `goog.Uri.QueryData`

QueryData.createFromMap( `map`, `opt_ignoreCase` ) `→` `goog.Uri.QueryData`