@playlive/fundraiser-data
    Preparing search index...

    Interface FetchDonationTrainsParams

    Params for fetchDonationTrains.

    interface FetchDonationTrainsParams {
        adminApiKey?: string;
        allowEnded?: boolean;
        campaignID: string;
        filterInvalid?: boolean;
        signal?: AbortSignal;
        tiltifyOAuthToken?: string;
    }

    Hierarchy (View Summary)

    Index
    adminApiKey? allowEnded? campaignID filterInvalid? signal? tiltifyOAuthToken?
    adminApiKey?: string

    Shared admin API key sent as x-api-key.

    allowEnded?: boolean

    When true (default), include trains whose status is ENDED. Dashboards want the full history; on-stream overlays want only the live rolling window.

    campaignID: string

    Tiltify campaign ID whose trains to list.

    filterInvalid?: boolean

    When true (default), filter out trains the service considers invalid (typically: below the ruleset's threshold at the time of fire).

    signal?: AbortSignal

    Cancel on React unmount / other lifecycle events.

    tiltifyOAuthToken?: string

    Tiltify OAuth token sent as Authorization: OAuth <token>.

    Settings
    Member Visibility

    On This Page
    Properties