Class: ClaimReward<T>

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

Extends#

• BaseNumberTypeClass<ClaimReward<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iClaimReward<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iClaimReward<T>

Returns#

ClaimReward<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

automatic?#

optional automatic?: boolean

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

If true, the reward is automatically given to the user upon completion. No in-site logic is required.

Implementation of#

iClaimReward.automatic

---

calculationMethod?#

optional calculationMethod?: object

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

Calculation method to use for the gated content. This is used to determine who is shown the gated content.

By default, we check min 1 claim success for indexed claims and criteria met for non-indexed claims.

alwaysShow?#

optional alwaysShow?: boolean

minClaimSuccesses?#

optional minClaimSuccesses?: number

Implementation of#

iClaimReward.calculationMethod

---

gatedContent#

gatedContent: iClaimGatedContent

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

The gated content to display upon completion.

Implementation of#

iClaimReward.gatedContent

---

instanceId#

instanceId: string

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

The instance ID of the reward. A unique identifier for the reward.

Implementation of#

iClaimReward.instanceId

---

metadata?#

optional metadata?: object

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

Metadata for the reward. This is public-facing, so do not include any gated content here. By default, we use the associated rewardId.

description#

description: string

image#

image: string

name#

name: string

Implementation of#

iClaimReward.metadata

---

rewardId#

rewardId: string

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

The ID of the reward (either a pre-configured one or "custom"). Currently, this is not used for anything.

Implementation of#

iClaimReward.rewardId

Methods#

clone()#

clone(): ClaimReward

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

Deep copies the object and returns a new instance.

Returns#

ClaimReward

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ClaimReward<U>

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

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

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

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

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

Inherited from#

BaseNumberTypeClass.toJsonString