Interface iBitBadgesCollection<T>

interface iBitBadgesCollection<T> {
    _docId: string;
    _id?: string;
    activity: iTransferActivityDoc<T>[];
    aliasAddress: string;
    approvalTrackers: iApprovalTrackerDoc<T>[];
    badgeMetadataTimeline: iBadgeMetadataTimelineWithDetails<T>[];
    balancesType: "Standard" | "Off-Chain - Indexed" | "Non-Public" | "Off-Chain - Non-Indexed";
    claims: iClaimDetails<T>[];
    collectionApprovals: iCollectionApprovalWithDetails<T>[];
    collectionId: T;
    collectionMetadataTimeline: iCollectionMetadataTimelineWithDetails<T>[];
    collectionPermissions: iCollectionPermissionsWithDetails<T>;
    createdBlock: T;
    createdBy: string;
    createdTimestamp: T;
    customDataTimeline: iCustomDataTimeline<T>[];
    defaultBalances: iUserBalanceStoreWithDetails<T>;
    isArchivedTimeline: iIsArchivedTimeline<T>[];
    managerTimeline: iManagerTimeline<T>[];
    merkleChallenges: iMerkleChallengeDoc<T>[];
    nsfw?: {
        badgeIds: iUintRange<T>[];
        reason: string;
    };
    offChainBalancesMetadataTimeline: iOffChainBalancesMetadataTimeline<T>[];
    owners: iBalanceDocWithDetails<T>[];
    reported?: {
        badgeIds: iUintRange<T>[];
        reason: string;
    };
    reservedMap?: iMapDoc<T>;
    reviews: iReviewDoc<T>[];
    standardsTimeline: iStandardsTimeline<T>[];
    updateHistory: iUpdateHistory<T>[];
    views: {
        [viewId: string]: {
            ids: string[];
            pagination: PaginationInfo;
            type: string;
        } | undefined;
    };
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_docId _id? activity aliasAddress approvalTrackers badgeMetadataTimeline balancesType claims collectionApprovals collectionId collectionMetadataTimeline collectionPermissions createdBlock createdBy createdTimestamp customDataTimeline defaultBalances isArchivedTimeline managerTimeline merkleChallenges nsfw? offChainBalancesMetadataTimeline owners reported? reservedMap? reviews standardsTimeline updateHistory views

Properties

_docId

_docId: string

A unique stringified document ID

Optional _id

_id?: string

A unique document ID (Mongo DB ObjectID)

activity

activity: iTransferActivityDoc<T>[]

The fetched activity for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

aliasAddress

aliasAddress: string

The alias cosmos address for the collection

approvalTrackers

approvalTrackers: iApprovalTrackerDoc<T>[]

The fetched approval trackers for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

badgeMetadataTimeline

badgeMetadataTimeline: iBadgeMetadataTimelineWithDetails<T>[]

The badge metadata timeline for this collection, with off-chain metadata populated.

balancesType

balancesType: "Standard" | "Off-Chain - Indexed" | "Non-Public" | "Off-Chain - Non-Indexed"

The type of balances (i.e. "Standard", "Off-Chain - Indexed", "Non-Public, "Off-Chain - Non-Indexed")

claims

claims: iClaimDetails<T>[]

Details about any off-chain claims for this collection. Only applicable when outsourced to BitBadges.

collectionApprovals

collectionApprovals: iCollectionApprovalWithDetails<T>[]

The collection approvals for this collection, with off-chain metadata populated.

collectionId

collectionId: T

The collection ID

collectionMetadataTimeline

collectionMetadataTimeline: iCollectionMetadataTimelineWithDetails<T>[]

The collection metadata timeline for this collection, with off-chain metadata populated.

collectionPermissions

collectionPermissions: iCollectionPermissionsWithDetails<T>

The collection permissions for this collection, with off-chain metadata populated.

createdBlock

createdBlock: T

The block number when this collection was created

createdBy

createdBy: string

The cosmos address of the user who created this collection

createdTimestamp

createdTimestamp: T

The timestamp when this collection was created (milliseconds since epoch)

customDataTimeline

customDataTimeline: iCustomDataTimeline<T>[]

The custom data timeline

defaultBalances

defaultBalances: iUserBalanceStoreWithDetails<T>

The default balances for users upon genesis, with off-chain metadata populated.

isArchivedTimeline

isArchivedTimeline: iIsArchivedTimeline<T>[]

The is archived timeline

managerTimeline

managerTimeline: iManagerTimeline<T>[]

The manager timeline

merkleChallenges

merkleChallenges: iMerkleChallengeDoc<T>[]

The fetched merkle challenges for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

Optional nsfw

nsfw?: {
    badgeIds: iUintRange<T>[];
    reason: string;
}

The badge IDs in this collection that are marked as NSFW.

Type declaration

offChainBalancesMetadataTimeline

offChainBalancesMetadataTimeline: iOffChainBalancesMetadataTimeline<T>[]

The off-chain balances metadata timeline

owners

owners: iBalanceDocWithDetails<T>[]

The fetched owners of this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

Optional reported

reported?: {
    badgeIds: iUintRange<T>[];
    reason: string;
}

The badge IDs in this collection that have been reported.

Type declaration

Optional reservedMap

reservedMap?: iMapDoc<T>

The reserved map for the account. This is created and managed on-chain through the x/maps module.

reviews

reviews: iReviewDoc<T>[]

The fetched reviews for this collection. Returned collections will only fetch the current page. Use the pagination to fetch more. To be used in conjunction with views.

standardsTimeline

standardsTimeline: iStandardsTimeline<T>[]

The standards timeline

updateHistory

updateHistory: iUpdateHistory<T>[]

The update history of this collection

views

views: {
    [viewId: string]: {
        ids: string[];
        pagination: PaginationInfo;
        type: string;
    } | undefined;
}

The views for this collection and their pagination Doc. Views will only include the doc _ids. Use the pagination to fetch more. To be used in conjunction with activity, announcements, reviews, owners, merkleChallenges, and approvalTrackers. For example, if you want to fetch the activity for a view, you would use the view's pagination to fetch the doc _ids, then use the corresponding activity array to find the matching docs.

Type declaration

  • [viewId: string]: {
        ids: string[];
        pagination: PaginationInfo;
        type: string;
    } | undefined

Settings

Member Visibility

Theme

On This Page

_docId_idactivityaliasAddressapprovalTrackersbadgeMetadataTimelinebalancesTypeclaimscollectionApprovalscollectionIdcollectionMetadataTimelinecollectionPermissionscreatedBlockcreatedBycreatedTimestampcustomDataTimelinedefaultBalancesisArchivedTimelinemanagerTimelinemerkleChallengesnsfwoffChainBalancesMetadataTimelineownersreportedreservedMapreviewsstandardsTimelineupdateHistoryviews