CatalogSearchParams¶
Stores parameters used in catalog searches via AvatarEditorService.SearchCatalogAsync().
Not implemented in Nova
This datatype is not registered in Nova's Lua VM. Constructing or receiving it from an API call will not work.
Description¶
The CatalogSearchParams data type stores the parameters of a catalog search via AvatarEditorService.SearchCatalogAsync().
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 = 5000
params.MaxPrice = 10000
params.BundleTypes = {Enum.BundleType.Animations, Enum.BundleType.BodyParts}
local types = params.BundleTypes
for _, val in types do
print(val)
end
-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only
Properties¶
SearchKeyword Not yet The keyword to search for catalog results with.
MinPrice Not yet The minimum item price to search for.
MaxPrice Not yet The maximum item price to search for.
SortType Not yet The order in which to sort the results.
The order in which to sort the results.
The order in which to sort the results, represented by a CatalogSortType.
SortAggregation Not yet The time period to use to aggregate the sort results.
The time period to use to aggregate the sort results.
The time period to use to aggregate the sort results by, represented by a CatalogSortAggregation. This only applies when the sort type is CatalogSortType.MostFavorited or CatalogSortType.BestSelling. It does not apply for other sort types.
CategoryFilter Not yet The category to filter the search by.
The category to filter the search by.
The category to filter the search by, represented by a CatalogCategoryFilter.
SalesTypeFilter Not yet The sales type filter the search by.
The sales type filter the search by.
The sales type to filter the search by, represented by a SalesTypeFilter. Use SalesTypeFilter.TimedOptions to return only items that have timed options available.
BundleTypes Not yet An array containing BundleType values to filter the search by.
An array containing BundleType values to filter the search by.
AssetTypes Not yet An array containing AvatarAssetType values to filter the search by.
An array containing AvatarAssetType values to filter the search by.
IncludeOffSale Not yet Whether off sale items should be included in the results.
CreatorName Not yet Search for items with the given creator name.
Search for items with the given creator name. Specify whether to search users, groups, or both with CatalogSearchParams.CreatorType.
CreatorType Not yet Search for items created by the given creator type.
Search for items created by the given creator type. When unspecified, it defaults to returning creations from both CreatorTypeFilter.User and CreatorTypeFilter.Group. Searching by CatalogSearchParams.CreatorId with CreatorTypeFilter.All results in a HTTP 400 Bad Request error.
CreatorId Not yet Search for items created by the given creator ID.
Search for items created by the given creator ID.
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 Not yet Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.
Roblox reference: CatalogSearchParams