@playlive/react-query
    Preparing search index...

    Interface UseLeaderboardWithExclusionsParams

    Params for useLeaderboardWithExclusions.

    interface UseLeaderboardWithExclusionsParams {
        campaignID: string | null | undefined;
        charityType: CharityType;
        count?: number;
        endDate?: string | Date;
        isTeam?: boolean;
        startDate?: string | Date;
        timeType?: TiltifyLeaderboardTimeType;
    }
    Index
    campaignID charityType count? endDate? isTeam? startDate? timeType?
    campaignID: string | null | undefined

    Tiltify campaign ID. null / empty auto-disables the query.

    charityType: CharityType
    count?: number

    Max entries to return. Defaults to the service default (100).

    endDate?: string | Date

    Inclusive ISO 8601 upper bound. See startDate.

    isTeam?: boolean

    true when campaignID is a Tiltify team campaign UUID.

    startDate?: string | Date

    Inclusive ISO 8601 lower bound. Switches the service to the ad-hoc window path.

    timeType?: TiltifyLeaderboardTimeType

    Fixed calendar bucket for the default path. Ignored when either startDate or endDate is supplied.

    Settings
    Member Visibility

    On This Page
    Properties