Skip to main content

Interface: Collection

Collection Record.

Hierarchy​

Properties​

access​

• access: Access

Access to collection.

accessAwards​

• accessAwards: string[]

Field used with access to specify awards uid (Award)

accessCollections​

• accessCollections: string[]

Field used with access to specify collections uid (Collection)

approved​

• approved: boolean

Approved collection

Inherited from​

CollectionBase.approved

availableFrom​

• availableFrom: Timestamp

Date this collection will be available for sale from.

availableNfts​

• Optional availableNfts: number

Available NFTs for sale.

availablePrice​

• availablePrice: number

Initial price for this collection to be sold at.

bannerUrl​

• bannerUrl: string

Collection banner URL. This must be link to Build.5 storage.

Inherited from​

CollectionBase.bannerUrl

category​

• category: Categories

Collection Category.

createdBy​

• Optional createdBy: string

Member UID Member

Inherited from​

CollectionBase.createdBy

createdOn​

• Optional createdOn: Timestamp

Date/time it was created on.

Inherited from​

CollectionBase.createdOn

description​

• description: string

Collecton description.

Inherited from​

CollectionBase.description

discord​

• discord: string

Link to discord related to this collection.

Inherited from​

CollectionBase.discord

discounts​

• discounts: DiscountLine[]

Discount lines

Inherited from​

CollectionBase.discounts

floorPrice​

• Optional floorPrice: number

Cheapest price for NFT available within this collection.

ipfsMedia​

• Optional ipfsMedia: string

IPFS media link CID

Inherited from​

CollectionBase.ipfsMedia

ipfsMetadata​

• Optional ipfsMetadata: string

IPFS Metadata link CID

Inherited from​

CollectionBase.ipfsMetadata

ipfsRoot​

• Optional ipfsRoot: string

IPFS link to root directory that contains both ipfsMedia & ipfsMetadata

Inherited from​

CollectionBase.ipfsRoot

lastTradedOn​

• lastTradedOn: Timestamp

Last traded collection on date

Inherited from​

CollectionBase.lastTradedOn

limitedEdition​

• Optional limitedEdition: boolean

Is this collection limited? If so, no new NFT can be added once approved.

Inherited from​

CollectionBase.limitedEdition

mediaStatus​

• Optional mediaStatus: MediaStatus

Status of media upload to IFPS.

mintingData​

• Optional mintingData: NftMintingData

Collection minting status and details.

name​

• name: string

Collection name.

Inherited from​

CollectionBase.name

nftsOnAuction​

• Optional nftsOnAuction: number

NFTs available for auction.

nftsOnSale​

• Optional nftsOnSale: number

NFTs available for sale.

onePerMemberOnly​

• onePerMemberOnly: boolean

Only one NFT can be purchase within this collection by member.

placeholderNft​

• placeholderNft: string

Link to placeholder NFT Nft

placeholderUrl​

• placeholderUrl: string

Place holder URL to the image. This is used to reduce queries on NFT collection.

price​

• price: number

TODODOC

rankAvg​

• Optional rankAvg: number

Rank average.

rankCount​

• Optional rankCount: number

Total number of ranks.

rankSum​

• Optional rankSum: number

Sum of all ranks

rejected​

• rejected: boolean

Rejected collection

Inherited from​

CollectionBase.rejected

royaltiesFee​

• royaltiesFee: number

Roaylty fee per space.

Inherited from​

CollectionBase.royaltiesFee

royaltiesSpace​

• Optional royaltiesSpace: string

Roaylty space Space

Inherited from​

CollectionBase.royaltiesSpace

sold​

• sold: number

Total sold NFTs from initial sale.

Inherited from​

CollectionBase.sold

space​

• Optional space: string

Space UID

stakedNft​

• Optional stakedNft: number

Total number of staked NFTs

status​

• Optional status: CollectionStatus

Collection Status.

total​

• total: number

Total number of NFTs currently deposited within the system.

Inherited from​

CollectionBase.total

totalTrades​

• totalTrades: number

Stats: Total trades within this collection

Inherited from​

CollectionBase.totalTrades

twitter​

• twitter: string

Twitter Link

Inherited from​

CollectionBase.twitter

type​

• type: CollectionType

Collection Type.

updatedOn​

• Optional updatedOn: Timestamp

Date/time it was updated on.

Inherited from​

CollectionBase.updatedOn

url​

• url: string

URL Link

Inherited from​

CollectionBase.url

votes​

• Optional votes: VoteStats

Vote stats.