Mixin: LocationUrlHelperMixin

Members

---

locationId :number

The first available location ID from the locationIds property. Setting this replaces any existing location IDs with an array of just that value.

Type:

• number

---

locationIds :Array.<number>

An array of location IDs, set on the locationIds parameter

Type:

• Array.<number>

---

sourceId :string

The first available source ID from the sourceIds property. Setting this replaces any existing location IDs with an array of just that value.

Type:

• string

---

sourceIds :Array.<string>

An array of source IDs, set on the sourceIds parameter

Type:

• Array.<string>

Methods

---

findLocationsUrl(filter [, sorts] [, pagination])

Generate a URL to find locations based on a search criteria.

Parameters:

Name	Type	Argument	Description
filter	module:domain~Location		the search criteria
sorts	Array.<module:domain~SortDescriptor>	<optional>	optional sort settings to use
pagination	module:domain~Pagination	<optional>	optional pagination settings to use

Returns:

the generated URL

Type

string