Class: GetClaimAttemptsPayload

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

Extends#

• CustomTypeClass<GetClaimAttemptsPayload>

Implements#

• iGetClaimAttemptsPayload

Constructors#

Constructor#

new GetClaimAttemptsPayload(payload): GetClaimAttemptsPayload

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

Parameters#

payload#

iGetClaimAttemptsPayload

Returns#

GetClaimAttemptsPayload

Overrides#

CustomTypeClass.constructor

Properties#

address?#

optional address?: string

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

The specific address to fetch claims for. If blank, we fetch most recent claims.

Implementation of#

iGetClaimAttemptsPayload.address

---

bookmark?#

optional bookmark?: string

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

The bookmark to start from.

Implementation of#

iGetClaimAttemptsPayload.bookmark

---

includeErrors?#

optional includeErrors?: boolean

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

Whether to include errors or not.

Implementation of#

iGetClaimAttemptsPayload.includeErrors

Methods#

clone()#

clone(): GetClaimAttemptsPayload

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

Deep copies the object and returns a new instance.

Returns#

GetClaimAttemptsPayload

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): GetClaimAttemptsPayload

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

Parameters#

query#

ParsedQs

Returns#

GetClaimAttemptsPayload