Class: AwardDataset<D>

Award HTTPS Dataset object

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Award>

  ↳ AwardDataset

Methods

addOwner

▸ addOwner(req): Promise<Award>

Add owner of the award. This grants the ability to manage it.

Parameters

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

Returns

Promise<Award>

---

approveParticipant

▸ approveParticipant(req): Promise<AwardApproveParticipantResponse>

Approve participants and distribute them with token and NFT

Parameters

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

Returns

Promise<AwardApproveParticipantResponse>

---

cancel

▸ cancel(req): Promise<Award>

Cancel ongoing award and get refunded with remaining tokens.

Parameters

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

Returns

Promise<Award>

---

create

▸ create(req): Promise<Award>

Create Award

Parameters

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

Returns

Promise<Award>

---

fund

▸ fund(req): Promise<Transaction>

Fund award with native or base token.

Parameters

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

Returns

Promise<Transaction>

---

getActiveLive

▸ getActiveLive(space, startAfter?): Observable<Award[]>

Helper GET function to get "active" awards per space. Returns observable with continues updates via Websocket.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Award[]>

---

getAllUpdatedAfter

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

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Award[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

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

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

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Award[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

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

Get records by field.

Parameters

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

Returns

Promise<Award[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

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

Get records by field. Real time stream.

Parameters

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

Returns

Observable<Award[]>

Inherited from

DatasetClass.getByFieldLive

---

getBySpace

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

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Award[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

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

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Award[]>

Inherited from

DatasetClass.getBySpaceLive

---

getCompletedLive

▸ getCompletedLive(space, startAfter?): Observable<Award[]>

Helper GET function to get "completed" awards per space. Returns observable with continues updates via Websocket.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Award[]>

---

getDraftLive

▸ getDraftLive(space, startAfter?): Observable<Award[]>

Helper GET function to get "draft" awards per space. Returns observable with continues updates via Websocket.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Award[]>

---

getLastActiveLive

▸ getLastActiveLive(startAfter?): Observable<Award[]>

Helper GET function to get closest finishing awards. Returns observable with continues updates via Websocket.

Parameters

Name	Type
startAfter?	string

Returns

Observable<Award[]>

---

getManyById

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

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Award[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

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

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Award[]>

Inherited from

DatasetClass.getManyByIdLive

---

getRejectedLive

▸ getRejectedLive(space, startAfter?): Observable<Award[]>

Helper GET function to get "rejected" awards per space. Returns observable with continues updates via Websocket.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Award[]>

---

getTopByMemberLive

▸ getTopByMemberLive(member, completed, startAfter?): Observable<Award[]>

Helper GET Award participants. Returns observable with continues updates via Websocket.

Parameters

Name	Type
member	string
completed	boolean
startAfter?	string

Returns

Observable<Award[]>

---

id

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

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Award>

Inherited from

DatasetClass.id

---

participate

▸ participate(req): Promise<AwardParticipant>

Participate in the award to receive badge and tokens.

Parameters

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

Returns

Promise<AwardParticipant>

---

reject

▸ reject(req): Promise<Award>

Reject award

Parameters

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

Returns

Promise<Award>