Interface GetCollectionByIdBody

interface GetCollectionByIdBody {
    approvalTrackersToFetch?: iAmountTrackerIdDetails<NumberType>[];
    challengeTrackersToFetch?: iChallengeTrackerIdDetails<NumberType>[];
    fetchPrivateParams?: boolean;
    fetchTotalBalances?: boolean;
    handleAllAndAppendDefaults?: boolean;
    metadataToFetch?: MetadataFetchOptions;
    viewsToFetch?: {
        address?: string;
        bookmark: string;
        oldestFirst?: boolean;
        viewId: string;
        viewType: CollectionViewKey;
    }[];
}

Hierarchy (view full)

Properties

approvalTrackersToFetch? challengeTrackersToFetch? fetchPrivateParams? fetchTotalBalances? handleAllAndAppendDefaults? metadataToFetch? viewsToFetch?

Properties

OptionalapprovalTrackersToFetch

approvalTrackersToFetch?: iAmountTrackerIdDetails<NumberType>[]

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

OptionalchallengeTrackersToFetch

challengeTrackersToFetch?: iChallengeTrackerIdDetails<NumberType>[]

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

OptionalfetchPrivateParams

fetchPrivateParams?: boolean

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

OptionalfetchTotalBalances

fetchTotalBalances?: boolean

If true, the total and mint balances will be fetched and will be put in owners[].

collection.owners.find(x => x.bitbadgesAddresss === 'Mint')

OptionalhandleAllAndAppendDefaults

handleAllAndAppendDefaults?: boolean

If true, we will append defaults with empty values.

OptionalmetadataToFetch

metadataToFetch?: MetadataFetchOptions

If present, we will fetch the metadata corresponding to the specified options.

Consider using pruneMetadataToFetch for filtering out previously fetched metadata.

OptionalviewsToFetch

viewsToFetch?: {
    address?: string;
    bookmark: string;
    oldestFirst?: boolean;
    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.

  • 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