bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface GetAdditionalCollectionDetailsPayload

    Defines the options for fetching additional collection details.

    A view is a way of fetching additional details about a collection, and these will be queryable in the response via the views property. Each view has a bookmark that is used for pagination and must be supplied to get the next page. If the bookmark is not supplied, the first page will be returned.

    interface GetAdditionalCollectionDetailsPayload {
        approvalTrackersToFetch?: iAmountTrackerIdDetails<NumberType>[];
        challengeTrackersToFetch?: iChallengeTrackerIdDetails<NumberType>[];
        disableDefaults?: boolean;
        fetchPrivateParams?: boolean;
        fetchTotalBalances?: boolean;
        viewsToFetch?: {
            address?: string;
            bookmark: string;
            oldestFirst?: boolean;
            tokenId?: NumberType;
            viewId: string;
            viewType: CollectionViewKey;
        }[];
    }
    Index

    Properties

    approvalTrackersToFetch? challengeTrackersToFetch? disableDefaults? fetchPrivateParams? fetchTotalBalances? viewsToFetch?

    Properties

    approvalTrackersToFetch?: iAmountTrackerIdDetails<NumberType>[]

    If present, the approvals trackers corresponding to the specified approvals tracker IDs will be fetched.

    challengeTrackersToFetch?: iChallengeTrackerIdDetails<NumberType>[]

    If present, the merkle challenge trackers corresponding to the specified merkle challenge IDs will be fetched.

    disableDefaults?: boolean

    Disable appending default approvals.

    fetchPrivateParams?: boolean

    Fetches private parameters for any claims in addition to public parameters.

    fetchTotalBalances?: boolean

    If true, the total and mint balances will be fetched.

    viewsToFetch?: {
        address?: string;
        bookmark: string;
        oldestFirst?: boolean;
        tokenId?: NumberType;
        viewId: string;
        viewType: CollectionViewKey;
    }[]

    If present, the specified views will be fetched.

    Type Declaration

    • Optionaladdress?: string

      If specified, we will only fetch this users' activity.

    • bookmark: string

      A bookmark to pass in for pagination. "" for first request.

    • OptionaloldestFirst?: boolean

      If defined, we will return the oldest items first.

    • OptionaltokenId?: NumberType

      IF specified, we will filter to this abdge ID (only applicable to utiity listings view currently)

    • viewId: string

      A unique view ID. This is used for pagination. All fetches w/ same ID should be made with same criteria.

    • viewType: CollectionViewKey

      The base view type to fetch.

    Settings

    Member Visibility

    On This Page

    Properties