Class: GetClaimPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:476

Extends#

• CustomTypeClass<GetClaimPayload>

Implements#

• iGetClaimPayload

Constructors#

Constructor#

new GetClaimPayload(payload): GetClaimPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:481

Parameters#

payload#

iGetClaimPayload

Returns#

GetClaimPayload

Overrides#

CustomTypeClass.constructor

Properties#

fetchAllClaimedUsers?#

optional fetchAllClaimedUsers?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:478

Fetch all claimed users for the claim. If true, you will be able to find all { [bitbadgesAddress]: [...zeroIndexedClaimNumbers] } on the numUses plugin's publicState.

Implementation of#

iGetClaimPayload.fetchAllClaimedUsers

---

fetchPrivateParams?#

optional fetchPrivateParams?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:477

Fetch private parameters for the claim. Only applicable if you are the creator / manager of the claim.

Implementation of#

iGetClaimPayload.fetchPrivateParams

---

privateStatesToFetch?#

optional privateStatesToFetch?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:479

The private state instance IDs to fetch. By default, we do not fetch any private states.

Implementation of#

iGetClaimPayload.privateStatesToFetch

Methods#

clone()#

clone(): GetClaimPayload

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

Deep copies the object and returns a new instance.

Returns#

GetClaimPayload

Inherited from#

CustomTypeClass.clone

---

convert()#

convert<U>(_convertFunction?, options?): CustomType<any>

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

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from#

CustomTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString

---

FromQuery()#

static FromQuery(query): GetClaimPayload

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:488

Parameters#

query#

ParsedQs

Returns#

GetClaimPayload