Class: GetCollectionIndexPayload

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

Extends#

• CustomTypeClass<GetCollectionIndexPayload>

Implements#

• iGetCollectionIndexPayload

Constructors#

Constructor#

new GetCollectionIndexPayload(payload): GetCollectionIndexPayload

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

Parameters#

payload#

iGetCollectionIndexPayload

Returns#

GetCollectionIndexPayload

Overrides#

CustomTypeClass.constructor

Properties#

bookmark?#

optional bookmark?: string

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

Pagination bookmark ("" / omitted for first page).

Implementation of#

iGetCollectionIndexPayload.bookmark

---

createdBy?#

optional createdBy?: string

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

Creator bech32 address. Required for per-creator dashboards; omit for global browse.

Implementation of#

iGetCollectionIndexPayload.createdBy

---

name?#

optional name?: string

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

Case-insensitive name search.

Implementation of#

iGetCollectionIndexPayload.name

---

payerAddress?#

optional payerAddress?: string

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

Exact-match payer address (e.g. invoices where the connected user is the payer → "sending").

Implementation of#

iGetCollectionIndexPayload.payerAddress

---

recipientAddress?#

optional recipientAddress?: string

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

Exact-match recipient address (e.g. invoices where the connected user is the recipient → "receiving").

Implementation of#

iGetCollectionIndexPayload.recipientAddress

---

standard?#

optional standard?: string

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

Standard to scope to (e.g. 'PaymentRequest', 'Prediction Market'). Omit for cross-standard.

Implementation of#

iGetCollectionIndexPayload.standard

---

status?#

optional status?: string[]

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

Status keys to include (OR). Clock-only statuses (e.g. 'expired') are resolved at query time.

Implementation of#

iGetCollectionIndexPayload.status

Methods#

clone()#

clone(): GetCollectionIndexPayload

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

Deep copies the object and returns a new instance.

Returns#

GetCollectionIndexPayload

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

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

Parameters#

query#

ParsedQs

Returns#

GetCollectionIndexPayload