NftCollection class

Inheritance

Constructors

NftCollection(String uuid, Map<String, dynamic>? data)
Constructor which should only be called via Nft class. @param uuid Unique identifier of the NFT collection. @param data Data to populate the collection with.

Properties

apiPrefix ↔ String?
API url prefix for this class.
getter/setter pairinherited
baseExtension ↔ String?
Base extension from which uri for each token is calculated from: Base uri + token id + base extension.
getter/setter pair
baseUri ↔ String?
Base uri from which uri for each token is calculated from: Base uri + token id + base extension.
getter/setter pair
chain ↔ EvmChain?
Chain on which the smart contract was deployed.
getter/setter pair
collectionStatus ↔ CollectionStatus?
Status of the collection. From not deployed etc.
getter/setter pair
collectionType ↔ CollectionType?
Collection type. Defines the smart contract used.
getter/setter pair
contractAddress ↔ String?
Smart contract address (available after succesfull deploy).
getter/setter pair
createTime ↔ String?
The object's creation date
getter/setter pairinherited
deployerAddress ↔ String?
Wallet address of deployer.
getter/setter pair
description ↔ String?
collection description.
getter/setter pair
drop ↔ bool?
If this collection has drop (anyone can buy a nft directly from the smart contract) functionality enabled.
getter/setter pair
dropPrice ↔ int?
Price per NFT if drop is active.
getter/setter pair
dropReserve ↔ int?
Amount of reserved NFTs that can't be bought by general public but can get minted by the collection owner.
getter/setter pair
dropStart ↔ int?
UNIX timestamp of when general buying of NFTs start.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
isAutoIncrement ↔ bool?
If true, NFT token IDs are always sequential. If false, custom token IDs can be provided when minting.
getter/setter pair
isRevokable ↔ bool?
If collection owner can burn / destroy a NFT.
getter/setter pair
isSoulbound ↔ bool?
If nft is transferable.
getter/setter pair
maxSupply ↔ int?
Max amount of NFTs that can get minted in this collection. 0 represents unlimited.
getter/setter pair
name ↔ String?
Collection name
getter/setter pair
royaltiesAddress ↔ String?
Address to which royalties are paid.
getter/setter pair
royaltiesFees ↔ int?
Percentage amount of royalties fees.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
symbol ↔ String?
Collection symbol.
getter/setter pair
transactionHash ↔ String?
Transaction hash of contract deploy.
getter/setter pair
updateTime ↔ String?
The date when the object was last updated
getter/setter pairinherited
uuid ↔ String
Unique identifier of the model.
getter/setter pairinherited

Methods

burn(String tokenId) → Future<INftActionResponse>
Burns a nft. @warn Can only burn NFTs if the collection is revokable. @param tokenId Token ID of the NFT we want to burn. @returns Status.
get() → Future<NftCollection>
Gets and populates collection information. @returns Collection instance.
listTransactions(ITransactionFilters? params) → Future<IApillonList<ITransaction>>
Gets list of transactions that occurred on this collection through Apillon. @param params Filters. @returns List of transactions.
mint(IMintNftData params) → Future<INftActionResponse>
@param {IMintNftData} params - NFT mint parameters @returns {INftActionResponse} - success status and transaction hash of the mint
nestMint(String parentCollectionUuid, int parentNftId, int quantity) → Future<INftActionResponse>
Mints new nfts directly to an existing nft. @warn This method is only available for nestable collections. @param parentCollectionUuid UUID of the collection we want to nest mint to. @param parentNftId ID of the nft in the collection we want to nest mint to. @param quantity Amount of nfts we want to mint. @returns Call status.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
populate(dynamic data) → dynamic
Populates class properties via data object. @param data Data object.
override
toMap() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited
transferOwnership(String address) → Future<NftCollection>
Transfers ownership of this collection. @warn Once ownership is transferred you cannot call mint methods anymore since you are the owner and you need to the smart contracts call directly on chain. @param address Address to which the ownership will be transferred. @returns Collection data.

Operators

operator ==(Object other) → bool
The equality operator.
inherited