Class ClaimDetails<T>

Constructors

constructor

new ClaimDetails<T>(data): ClaimDetails<T>
Type Parameters
- T extends NumberType
Parameters
- data: iClaimDetails<T>
Returns ClaimDetails<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/approvals.ts:123

Properties

_includesPrivateParams

_includesPrivateParams: boolean

Whether the claim fetch includes private params

`Optional`approach

approach?: string

Whether the claim is expected to be automatically triggered by someone (not the user).

`Optional`assignMethod

assignMethod?: string

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

`Optional`balancesToSet

balancesToSet?: PredeterminedBalances<T>

The balances to set for the claim. Only used for claims for collections that have off-chain indexed balances and are assigning balances based on the claim.

`Optional`categories

categories?: string[]

The categories of the claim

claimId

claimId: string

Unique claim ID.

`Optional`collectionId

collectionId?: T

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

`Optional`createdBy

createdBy?: string

The original creator of the claim

`Optional`estimatedCost

estimatedCost?: string

Estimated cost for the claim.

`Optional`estimatedTime

estimatedTime?: string

Estimated time to satisfy the claim's requirements.

`Optional`lastUpdated

lastUpdated?: T

Last updated timestamp for the claim.

`Optional`listId

listId?: string

Address list ID that the claim is for (if applicable).

`Optional`manualDistribution

manualDistribution?: boolean

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

`Optional`metadata

metadata?: Metadata<T>

Metadata for the claim.

plugins

plugins: IntegrationPluginDetails<string>[]

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

`Optional`rewards

rewards?: ClaimReward<T>[]

Rewards for the claim.

`Optional`satisfyMethod

satisfyMethod?: SatisfyMethod

Custom satisfaction logic

`Optional`seedCode

seedCode?: string

Seed code for the claim.

`Optional`showInSearchResults

showInSearchResults?: boolean

If true, the claim will be shown in search results

`Optional`siwbbClaim

siwbbClaim?: boolean

Is intended to be used for Sign In with BitBadges.

`Optional`trackerDetails

trackerDetails?: ChallengeTrackerIdDetails<T>

The tracker details for the claim.

version

version: T

The version of the claim.

Methods

clone

clone(): ClaimDetails<T>
Deep copies the object and returns a new instance.

Returns ClaimDetails<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert(convertFunction, options?): ClaimDetails
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((val: NumberType) => U)
 - - (val): U
 - Parameters
 val: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns ClaimDetails
Overrides BaseNumberTypeClass.convert
- Defined in src/core/approvals.ts:149

equals

equals(other, normalizeNumberTypes?): boolean
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 extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in src/core/approvals.ts:153

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

Class ClaimDetails<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ClaimDetails<T>

Properties

_includesPrivateParams

Optionalapproach

OptionalassignMethod

OptionalbalancesToSet

Optionalcategories

claimId

OptionalcollectionId

OptionalcreatedBy

OptionalestimatedCost

OptionalestimatedTime

OptionallastUpdated

OptionallistId

OptionalmanualDistribution

Optionalmetadata

plugins

Optionalrewards

OptionalsatisfyMethod

OptionalseedCode

OptionalshowInSearchResults

OptionalsiwbbClaim

OptionaltrackerDetails

version

Methods

clone

Returns ClaimDetails<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns ClaimDetails<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

Settings

On This Page

`Optional`approach

`Optional`assignMethod

`Optional`balancesToSet

`Optional`categories

`Optional`collectionId

`Optional`createdBy

`Optional`estimatedCost

`Optional`estimatedTime

`Optional`lastUpdated

`Optional`listId

`Optional`manualDistribution

`Optional`metadata

`Optional`rewards

`Optional`satisfyMethod

`Optional`seedCode

`Optional`showInSearchResults

`Optional`siwbbClaim

`Optional`trackerDetails