Constructor.
Optional props: object | PropMapinitial property values
Readonly propsThe object that all properties are stored on.
Get the number of properties configured.
An array of tags.
A user ID.
This manages the first available location ID from the userIds property.
An array of user IDs.
Get a property value.
the key to get
the associated value for the given key
Set or remove a property value.
the key to set the value for
the new value to set for the given key;
if null then the key property will be removed
this object
Get all properties.
all properties of this object copied into a simple object
Set or remove multiple properties.
the new values to set; if any value is null that property
will be deleted
this object
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 Util.Enum values will have their name property used.
Optional propertyName: stringan optional object property prefix to add to all properties
Optional callbackFn: PropMapUriEncodingCallbackFnAn optional function that will be called for each property.
The function will be passed property name and value arguments, and must
return either undefined to skip the property, a 2 or 3-element array with the
property name and value to use, and an optional boolean to force array
values to use mutliple parameter keys. Any other return value causes the
property to be used as-is.
the URI encoded string
Get this object as a standard URI encoded (query parameters) string value with sorting and pagination parameters.
This calls Util.PropMap.toUriEncoding first, then encodes
the sorts and pagination parameters, if provided.
Optional sorts: SortDescriptor[]optional sort settings to use
Optional pagination: Paginationoptional pagination settings to use
Optional propertyName: stringan optional object property prefix to add to all properties
Optional callbackFn: PropMapUriEncodingCallbackFnAn optional function that will be called for each property.
The function will be passed property name and value arguments, and must
return either undefined 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.
the URI encoded string
Generated using TypeDoc
A filter criteria object for user metadata.
This filter is used to query user metadata.