Interface iFilterBadgesInCollectionPayload

interface iFilterBadgesInCollectionPayload {
    attributes?: { name: string; value: string | number | boolean }[];
    badgeIds?: iUintRange<NumberType>[];
    bookmark?: string;
    categories?: string[];
    mostViewed?: "daily" | "allTime" | "weekly" | "monthly" | "yearly";
    tags?: string[];
}

Properties

attributes? badgeIds? bookmark? categories? mostViewed? tags?

Properties

Optionalattributes

attributes?: { name: string; value: string | number | boolean }[]

Attribute queries

OptionalbadgeIds

badgeIds?: iUintRange<NumberType>[]

Limit to specific badge IDs. Leave undefined to not filter by badge ID.

Optionalbookmark

bookmark?: string

Pagination bookmark. Leave undefined or "" for first request.

Optionalcategories

categories?: string[]

Limit to specific lists. Leave undefined to not filter by list.

OptionalmostViewed

mostViewed?: "daily" | "allTime" | "weekly" | "monthly" | "yearly"

mostViewed is a special view that sorts by most viewed badges. May be incompatible with other filters.

Optionaltags

tags?: string[]

Limit to specific lists. Leave undefined to not filter by list.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR