Class: CollectionDataset<D>

NFT Collection Dataset

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Collection>

  ↳ CollectionDataset

Methods

create

▸ create(req): Promise<Collection>

Create NFT Collection.

Parameters

Name	Type	Description
req	Build5Request<CreateCollectionRequest>	Use Build5Request with data based on CreateCollectionRequest

Returns

Promise<Collection>

---

getAllAvailableLive

▸ getAllAvailableLive(space, startAfter?): Observable<Collection[]>

Get all available collections per space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Collection[]>

---

getAllPendingLive

▸ getAllPendingLive(space, startAfter?): Observable<Collection[]>

Get all pending collections per space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Collection[]>

---

getAllRejectedLive

▸ getAllRejectedLive(space, startAfter?): Observable<Collection[]>

Get all rejected collections per space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Collection[]>

---

getAllUpdatedAfter

▸ getAllUpdatedAfter(updatedAfter, startAfter?): Promise<Collection[]>

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Collection[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

▸ getAllUpdatedAfterLive(updatedAfter, startAfter?): Observable<Collection[]>

Get all records updated after unix timestamp. Real time stream.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Collection[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

▸ getByField(fieldName, fieldValue, startAfter?): Promise<Collection[]>

Get records by field.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Promise<Collection[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

▸ getByFieldLive(fieldName, fieldValue, startAfter?): Observable<Collection[]>

Get records by field. Real time stream.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Observable<Collection[]>

Inherited from

DatasetClass.getByFieldLive

---

getBySpace

▸ getBySpace(space, startAfter?): Promise<Collection[]>

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Collection[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

▸ getBySpaceLive(space, startAfter?): Observable<Collection[]>

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Collection[]>

Inherited from

DatasetClass.getBySpaceLive

---

getManyById

▸ getManyById(setIds): Promise<Collection[]>

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Collection[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

▸ getManyByIdLive(setIds): Observable<Collection[]>

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Collection[]>

Inherited from

DatasetClass.getManyByIdLive

---

id

▸ id(setId): ExactDataSet<D, Collection>

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Collection>

Inherited from

DatasetClass.id

---

mint

▸ mint(req): Promise<Transaction>

Mint collection on defined network.

Parameters

Name	Type	Description
req	Build5Request<CollectionMintRequest>	Use Build5Request with data based on CollectionMintRequest

Returns

Promise<Transaction>

---

rank

▸ rank(req): Promise<Rank>

Rank collection. This typically is managed by Rank Moderators.

Parameters

Name	Type	Description
req	Build5Request<RankRequest>	Use Build5Request with data based on RankRequest

Returns

Promise<Rank>

---

reject

▸ reject(req): Promise<Collection>

Reject collection and hide it.

Parameters

Name	Type	Description
req	Build5Request<RejectCollectionRequest>	Use Build5Request with data based on RejectCollectionRequest

Returns

Promise<Collection>

---

update

▸ update(req): Promise<Collection>

Update NFT Collection.

Parameters

Name	Type	Description
req	Build5Request<UpdateCollectionRequest>	Use Build5Request with data based on UpdateCollectionRequest

Returns

Promise<Collection>

---

updateMinted

▸ updateMinted(req): Promise<Collection>

Update minted NFT Collection. Only certain fields are updated (typically those that are not immutable and stored on DLT)

Parameters

Name	Type	Description
req	Build5Request<UpdateCollectionRequest>	Use Build5Request with data based on UpdateCollectionRequest

Returns

Promise<Collection>

---

vote

▸ vote(req): Promise<Vote>

Give collection a vote up or down.

Parameters

Name	Type	Description
req	Build5Request<VoteRequest>	Use Build5Request with data based on VoteRequest

Returns

Promise<Vote>