Class UserMetadataFilter

Readonlyprops

size

• get size(): number

  Get the number of properties configured.

  Returns number

[iterator]

• "[iterator]"(): MapIterator<[string, any]>

  Get an iterator over the property entries.

  Returns MapIterator<[string, any]>

  iterator over [k, v] values

prop

• prop(key: string): any

  Get a property value.

  Parameters

  • key: string

    the key to get

  Returns any

  the associated value for the given key
• prop(key: string, newValue: any): this

  Set or remove a property value.

  Parameters

  • key: string

    the key to set the value for
  • newValue: any

    the new value to set for the given key; if null then the key property will be removed

  Returns this

  this object

properties

• properties(): Record<string, any>

  Get all properties.

  Returns Record<string, any>

  all properties of this object copied into a simple object
• properties(newProps: object | Map<string, any>): this

  Set or remove multiple properties.

  Parameters

  • newProps: object | Map<string, any>

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

  Returns this

  this object

toUriEncodingWithSorting

• toUriEncodingWithSorting(
      sorts?: SortDescriptor[],
      pagination?: Pagination,
      propertyName?: string,
      callbackFn?: PropMapUriEncodingCallbackFn,
  ): 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.

  Parameters

  • Optionalsorts: SortDescriptor[]

    optional sort settings to use
  • Optionalpagination: Pagination

    optional pagination settings to use
  • OptionalpropertyName: string

    an optional object property prefix to add to all properties
  • OptionalcallbackFn: PropMapUriEncodingCallbackFn

    An 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.

  Returns string

  the URI encoded string