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

    Interface iCollectionDoc<T>

    interface iCollectionDoc<T extends NumberType> {
        _docId: string;
        _id?: string;
        aliasPaths: iAliasPath<T>[];
        collectionApprovals: iCollectionApproval<T>[];
        collectionId: string;
        collectionMetadata: iCollectionMetadata;
        collectionPermissions: iCollectionPermissions<T>;
        cosmosCoinWrapperPaths: iCosmosCoinWrapperPath<T>[];
        createdBlock: T;
        createdBy: string;
        createdTimestamp: T;
        customData: string;
        defaultBalances: iUserBalanceStore<T>;
        invariants: iCollectionInvariants<T>;
        isArchived: boolean;
        manager: string;
        mintEscrowAddress: string;
        standards: string[];
        tokenMetadata: iTokenMetadata<T>[];
        updateHistory: iUpdateHistory<T>[];
        validTokenIds: iUintRange<T>[];
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    _docId _id? aliasPaths collectionApprovals collectionId collectionMetadata collectionPermissions cosmosCoinWrapperPaths createdBlock createdBy createdTimestamp customData defaultBalances invariants isArchived manager mintEscrowAddress standards tokenMetadata updateHistory validTokenIds

    Properties

    _docId

    _docId: string

    A unique stringified document ID

    Optional_id

    _id?: string

    A unique document ID (Mongo DB ObjectID)

    aliasPaths: iAliasPath<T>[]

    The alias (non-wrapping) paths for the collection

    collectionApprovals: iCollectionApproval<T>[]

    The collection approved transfers timeline

    collectionId: string

    The collection ID

    collectionMetadata: iCollectionMetadata

    The collection metadata

    collectionPermissions: iCollectionPermissions<T>

    The collection permissions

    cosmosCoinWrapperPaths: iCosmosCoinWrapperPath<T>[]

    The IBC wrapper paths for the collection

    createdBlock: T

    The block number when this collection was created

    createdBy: string

    The BitBadges address of the user who created this collection

    createdTimestamp: T

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

    customData: string

    The custom data

    defaultBalances: iUserBalanceStore<T>

    The default balances for users who have not interacted with the collection yet. Only used if collection has "Standard" balance type.

    invariants: iCollectionInvariants<T>

    Collection-level invariants that cannot be broken. These are set upon genesis and cannot be modified.

    isArchived: boolean

    The is archived flag

    manager: string

    The manager

    mintEscrowAddress: string

    Mint escrow address

    standards: string[]

    The standards

    tokenMetadata: iTokenMetadata<T>[]

    The token metadata

    updateHistory: iUpdateHistory<T>[]

    The update history of this collection

    validTokenIds: iUintRange<T>[]

    Valid token IDs for the collection

    Settings

    Member Visibility

    On This Page

    Properties