Class: ClaimDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:141

Extends#

• BaseNumberTypeClass<ClaimDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iClaimDetails<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:170

Parameters#

data#

iClaimDetails<T>

Returns#

ClaimDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

_includesPrivateParams#

_includesPrivateParams: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:162

Whether the claim fetch includes private params

Implementation of#

iClaimDetails._includesPrivateParams

---

_templateInfo?#

optional _templateInfo?: object

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:163

Internal

For internal use by the frontend.

completedTemplateStep?#

optional completedTemplateStep?: boolean

pluginId?#

optional pluginId?: string

supportedApproaches?#

optional supportedApproaches?: string[]

Implementation of#

iClaimDetails._templateInfo

---

approach?#

optional approach?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:145

How the claim is expected to be completed. This is for display purposes for the frontend.

Available options:

• in-site (default): The claim is expected to be completed in-site.
• api: The claim is expected to be completed via an API call.
• zapier: The claim is expected to be completed via Zapier auto-completion.

Typically, you will use the in-site approach

Implementation of#

iClaimDetails.approach

---

assignMethod?#

optional assignMethod?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:148

Algorithm to determine the claim number order. Blank is just incrementing claim numbers.

For most cases, you will not need to specify this.

Implementation of#

iClaimDetails.assignMethod

---

cachePolicy?#

optional cachePolicy?: ClaimCachePolicy<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:168

Cache policy for the claim. Only needed for on-demand claims.

Implementation of#

iClaimDetails.cachePolicy

---

categories?#

optional categories?: string[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:158

The categories of the claim

Implementation of#

iClaimDetails.categories

---

claimId#

claimId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:142

Unique claim ID.

Implementation of#

iClaimDetails.claimId

---

collectionId?#

optional collectionId?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:152

Collection ID that the claim is for (if applicable - collection claims).

Implementation of#

iClaimDetails.collectionId

---

createdBy?#

optional createdBy?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:160

The original creator of the claim

Implementation of#

iClaimDetails.createdBy

---

estimatedCost?#

optional estimatedCost?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:155

Estimated cost for the claim.

Implementation of#

iClaimDetails.estimatedCost

---

estimatedTime?#

optional estimatedTime?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:156

Estimated time to satisfy the claim's requirements.

Implementation of#

iClaimDetails.estimatedTime

---

lastUpdated?#

optional lastUpdated?: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:150

Last updated timestamp for the claim.

Implementation of#

iClaimDetails.lastUpdated

---

managedBy?#

optional managedBy?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:161

The BitBadges address of the user who is currently managing this

Implementation of#

iClaimDetails.managedBy

---

manualDistribution?#

optional manualDistribution?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:144

If manual distribution is enabled, we do not handle any distribution of claim codes. We leave that up to the claim creator.

Only applicable for on-chain token claims. This is only used in advanced self-hosted cases.

Implementation of#

iClaimDetails.manualDistribution

---

metadata?#

optional metadata?: Metadata<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:147

Metadata for the claim.

Implementation of#

iClaimDetails.metadata

---

plugins#

plugins: IntegrationPluginDetails<string>[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:143

Claim plugins. These are the criteria that must pass for a user to claim.

Implementation of#

iClaimDetails.plugins

---

rewards?#

optional rewards?: ClaimReward<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:154

Rewards for the claim.

Implementation of#

iClaimDetails.rewards

---

satisfyMethod?#

optional satisfyMethod?: SatisfyMethod

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:149

Custom satisfaction logic.

If left blank, all plugins must pass for the claim to be satisfied. Otherwise, you can specify a custom method to determine if the claim is satisfied.

Implementation of#

iClaimDetails.satisfyMethod

---

seedCode?#

optional seedCode?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:146

Seed code for the claim. Only used for on-chain token claims.

This is how we produce all reserved codes for the on-chain merkle challenge / proofs.

Implementation of#

iClaimDetails.seedCode

---

showInSearchResults?#

optional showInSearchResults?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:157

If true, the claim will be shown in search results

Implementation of#

iClaimDetails.showInSearchResults

---

standaloneClaim?#

optional standaloneClaim?: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:153

Standalone claims are not linked with a token or list.

Implementation of#

iClaimDetails.standaloneClaim

---

trackerDetails?#

optional trackerDetails?: ChallengeTrackerIdDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:159

The tracker details for the claim (if applicable - collection claims).

Implementation of#

iClaimDetails.trackerDetails

---

version#

version: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:151

The version of the claim.

Implementation of#

iClaimDetails.version

Methods#

clone()#

clone(): ClaimDetails

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

Deep copies the object and returns a new instance.

Returns#

ClaimDetails

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:197

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

ClaimDetails<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/core/approvals.ts:201

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