Skip to content

Class: CollectionDoc<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:349

Extends

Extended by

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

new CollectionDoc<T>(data): CollectionDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:375

Parameters

data

iCollectionDoc<T>

Returns

CollectionDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:353

A unique stringified document ID

Implementation of

iCollectionDoc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:354

A unique document ID (Mongo DB ObjectID)

Implementation of

iCollectionDoc._id

aliasPaths

aliasPaths: AliasPath<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:372

The alias (non-wrapping) paths for the collection

Implementation of

iCollectionDoc.aliasPaths

collectionApprovals

collectionApprovals: CollectionApproval<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:361

The collection approved transfers timeline

Implementation of

iCollectionDoc.collectionApprovals

collectionId

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:355

The collection ID

Implementation of

iCollectionDoc.collectionId

collectionMetadata

collectionMetadata: CollectionMetadata

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:356

The collection metadata

Implementation of

iCollectionDoc.collectionMetadata

collectionPermissions

collectionPermissions: CollectionPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:360

The collection permissions

Implementation of

iCollectionDoc.collectionPermissions

cosmosCoinWrapperPaths

cosmosCoinWrapperPaths: CosmosCoinWrapperPath<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:371

The IBC wrapper paths for the collection

Implementation of

iCollectionDoc.cosmosCoinWrapperPaths

createdBlock

createdBlock: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:366

The block number when this collection was created

Implementation of

iCollectionDoc.createdBlock

createdBy

createdBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:365

The BitBadges address of the user who created this collection

Implementation of

iCollectionDoc.createdBy

createdTimestamp

createdTimestamp: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:367

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

Implementation of

iCollectionDoc.createdTimestamp

customData

customData: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:358

The custom data

Implementation of

iCollectionDoc.customData

defaultBalances

defaultBalances: UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:364

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

Implementation of

iCollectionDoc.defaultBalances

invariants

invariants: CollectionInvariants<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:373

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

Implementation of

iCollectionDoc.invariants

isArchived

isArchived: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:363

The is archived flag

Implementation of

iCollectionDoc.isArchived

manager

manager: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:359

The manager

Implementation of

iCollectionDoc.manager

mintEscrowAddress

mintEscrowAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:370

Mint escrow address

Implementation of

iCollectionDoc.mintEscrowAddress

standards

standards: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:362

The standards

Implementation of

iCollectionDoc.standards

tokenMetadata

tokenMetadata: TokenMetadata<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:357

The token metadata

Implementation of

iCollectionDoc.tokenMetadata

updateHistory

updateHistory: UpdateHistory<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:368

The update history of this collection

Implementation of

iCollectionDoc.updateHistory

validTokenIds

validTokenIds: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:369

Valid token IDs for the collection

Implementation of

iCollectionDoc.validTokenIds

Methods

clone()

clone(): CollectionDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:416

Deep copies the object and returns a new instance.

Returns

CollectionDoc<T>

Implementation of

CustomType.clone

Overrides

BaseNumberTypeClass.clone

convert()

convert<U>(convertFunction, options?): CollectionDoc<U>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:412

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(val) => U

options?

ConvertOptions

Returns

CollectionDoc<U>

Implementation of

CustomType.convert

Overrides

BaseNumberTypeClass.convert

equals()

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters

U

U extends CustomType<U>

Parameters

other

CustomType<U> | null | undefined

normalizeNumberTypes?

boolean

Returns

boolean

Implementation of

CustomType.equals

Inherited from

BaseNumberTypeClass.equals

getDefaultUserBalance()

getDefaultUserBalance(): UserBalanceStore<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:404

Creates a blank balance object with the genesis default approvals and balances.

Returns

UserBalanceStore<T>

getNumberFieldNames()

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:408

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns

string[]

Implementation of

CustomType.getNumberFieldNames

Overrides

BaseNumberTypeClass.getNumberFieldNames

hasNumberFields()

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns

boolean

Implementation of

CustomType.hasNumberFields

Inherited from

BaseNumberTypeClass.hasNumberFields

toJson()

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns

JsonObject

Implementation of

CustomType.toJson

Inherited from

BaseNumberTypeClass.toJson

toJsonString()

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns

string

Implementation of

CustomType.toJsonString

Inherited from

BaseNumberTypeClass.toJsonString

Edit this page on GitHub