SolarNetwork Core

Class: UserMetadataFilter

domain~ UserMetadataFilter

A filter criteria object for user metadata.

This filter is used to query user metadata.

new UserMetadataFilter( [props])

Constructor.

Extends:
Parameters:
Name Type Argument Description
props object <optional>

initial property values

Extends

Members

props :object

The object that all properties are stored on.

Type:
  • object
Inherited From:

tags :Array.<string>

An array of tags.

Type:
  • Array.<string>

userId :number

A user ID.

This manages the first available location ID from the userIds property.

Type:
  • number

userIds :Array.<number>

An array of user IDs.

Type:
  • Array.<number>

Methods

prop(key [, newValue])

Get, set, or remove a property value.

Parameters:
Name Type Argument Description
key string

the key to get or set the value for
newValue * <optional>

if defined, the new value to set for the given key; if null then the key property will be removed
Inherited From:
Returns:

if called as a getter, the associated value for the given key, otherwise this object

Type
*

properties( [newProps])

Get, set, or remove multiple properties.

Parameters:
Name Type Argument Description
newProps object <optional>

the new values to set; if any value is null that property will be deleted
Inherited From:
Returns:

if called as a getter, all properties of this object copied into a simple object; otherwise this object

Type
object

toUriEncoding( [propertyName] [, callbackFn])

Get this object as a standard URI encoded (query parameters) string value.

All enumerable properties of the props property will be added to the result. If any property value is an array, the values of the array will be joined by a comma. Any module:util~Enum values will have their name property used. Any value that has a toUriEncoding() function property will have that function invoked, passing the associated property name as the first argument, and the returned value will be used.

Parameters:
Name Type Argument Description
propertyName string <optional>

an optional object property prefix to add to all properties
callbackFn function <optional>

An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either null to skip the property, a 2-element array with the property name and value to use, or anything else to use the property as- is.
Inherited From:
Overrides:
Returns:

the URI encoded string

Type
string

toUriEncodingWithSorting( [sorts] [, pagination] [, propertyName] [, callbackFn])

Get this object as a standard URI encoded (query parameters) string value with sorting and pagination parameters.

This calls module:util~PropMap#toUriEncoding first, then encodes the sorts and pagination parameters, if provided.

Parameters:
Name Type Argument Description
sorts Array.<module:domain~SortDescriptor> <optional>

optional sort settings to use
pagination module:domain~Pagination <optional>

optional pagination settings to use
propertyName string <optional>

an optional object property prefix to add to all properties
callbackFn function <optional>

An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either null to skip the property, a 2-element array with the property name and value to use, or anything else to use the property as- is.
Inherited From:
Returns:

the URI encoded string

Type
string