CatalogSearchParams

Show Deprecated

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 = 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

Summary

Properties

SearchKeyword:string
The keyword to search for catalog results with.
MinPrice:number
The minimum item price to search for.
MaxPrice:number
The maximum item price to search for.
SortType:Enum.CatalogSortType
The order in which to sort the results.
SortAggregation:Enum.CatalogSortAggregation
The time period to use to aggregate the sort results.
CategoryFilter:Enum.CatalogCategoryFilter
The category to filter the search by.
SalesTypeFilter:Enum.SalesTypeFilter
The sales type filter the search by.
BundleTypes:Array<Enum.BundleType>
An array containing Enum.BundleType values to filter the search by.
AssetTypes:Array<Enum.AvatarAssetType>
An array containing Enum.AvatarAssetType values to filter the search by.
IncludeOffSale:boolean
Whether off sale items should be included in the results.
CreatorName:string
Search for items with the given creator name.
CreatorType:Enum.CreatorTypeFilter
Search for items created by the given creator type.
CreatorId:number
Search for items created by the given creator ID.
Limit:number
Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.

Properties

SearchKeyword

string

The keyword to search for catalog results with.

MinPrice

number

The minimum item price to search for.

MaxPrice

number

The maximum item price to search for.

Default Value: 2147483647

SortType

Enum.CatalogSortType

The order in which to sort the results, represented by a Enum.CatalogSortType.

Default Value: Enum.CatalogSortType.Relevance

SortAggregation

Enum.CatalogSortAggregation

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.

Default Value: Enum.CatalogSortAggregation.AllTime

Enum.CatalogCategoryFilter

The category to filter the search by, represented by a Enum.CatalogCategoryFilter.

Default Value: Enum.CatalogCategoryFilter.None

SalesTypeFilter

Enum.SalesTypeFilter

The sales type the search by, represented by a Enum.SalesTypeFilter.

Default Value: Enum.SalesTypeFilter.All

BundleTypes

Array<Enum.BundleType>

An array containing Enum.BundleType values to filter the search by.

Default Value: {}

AssetTypes

Array<Enum.AvatarAssetType>

An array containing Enum.AvatarAssetType values to filter the search by.

IncludeOffSale

boolean

Whether off sale items should be included in the results.

CreatorName

string

Search for items with the given creator name. Specify whether to search users, groups, or both with CatalogSearchParams.CreatorType.

CreatorType

Enum.CreatorTypeFilter

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.

Default Value: Enum.CreatorTypeFilter.All

CreatorId

number

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

number

Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.