CatalogSearchParams
The CatalogSearchParams data type stores the parameters of a catalog search via AvatarEditorService:SearchCatalog().
When accessing the value of the CatalogSearchParams.BundleTypes or CatalogSearchParams.AssetTypes property the returned table will be read-only to avoid confusion when not directly accessing the CatalogSearchParams instance.
For example, you can use these properties as follows:
local params = CatalogSearchParams.new()params.SearchKeyword = "Test"params.MinPrice = 5000params.MaxPrice = 10000params.BundleTypes = {Enum.BundleType.Animations, Enum.BundleType.BodyParts}local types = params.BundleTypesfor _, val in types doprint(val)end-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only
Summary
Properties
The keyword to search for catalog results with.
The minimum item price to search for.
The maximum item price to search for.
The order in which to sort the results.
The time period to use to aggregate the sort results.
The category to filter the search by.
The sales type filter the search by.
An array containing Enum.BundleType values to filter the search by.
An array containing Enum.AvatarAssetType values to filter the search by.
Whether off sale items should be included in the results.
Search for items with the given creator name.
Search for items created by the given creator type.
Search for items created by the given creator ID.
Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.
Properties
SortType
The order in which to sort the results, represented by a Enum.CatalogSortType.
SortAggregation
The time period to use to aggregate the sort results by, represented by a Enum.CatalogCategoryFilter. This only applies when the sort type is Enum.CatalogSortType.MostFavorited or Enum.CatalogSortType.BestSelling. It does not apply for other sort types.
CategoryFilter
The category to filter the search by, represented by a Enum.CatalogCategoryFilter.
SalesTypeFilter
The sales type the search by, represented by a Enum.SalesTypeFilter.
CreatorName
Search for items with the given creator name. Specify whether to search users, groups, or both with CatalogSearchParams.CreatorType.
CreatorType
Search for items created by the given creator type. When unspecified, it defaults to returning creations from both Enum.CreatorTypeFilter.User and Enum.CreatorTypeFilter.Group. Searching by CatalogSearchParams.CreatorId with Enum.CreatorTypeFilter.All results in a HTTP 400 Bad Request error.
CreatorId
Search for items created by the single creator ID. Specify user or group with CatalogSearchParams.CreatorType. Searching by creator ID and creator name is not supported; specify one, not both.
Limit
Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.