Class: GetBalanceByAddressSuccessResponse<T>

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

Extends#

• BalanceDocWithDetails<T>

Type Parameters#

T#

T extends NumberType

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1022

Parameters#

data#

iBalanceDocWithDetails<T>

Returns#

GetBalanceByAddressSuccessResponse<T>

Inherited from#

BalanceDocWithDetails.constructor

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1011

A unique stringified document ID

Inherited from#

BalanceDocWithDetails._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1012

A unique document ID (Mongo DB ObjectID)

Inherited from#

BalanceDocWithDetails._id

---

autoApproveAllIncomingTransfers#

autoApproveAllIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1019

Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Inherited from#

BalanceDocWithDetails.autoApproveAllIncomingTransfers

---

autoApproveSelfInitiatedIncomingTransfers#

autoApproveSelfInitiatedIncomingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1017

Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

Inherited from#

BalanceDocWithDetails.autoApproveSelfInitiatedIncomingTransfers

---

autoApproveSelfInitiatedOutgoingTransfers#

autoApproveSelfInitiatedOutgoingTransfers: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1018

Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.

Inherited from#

BalanceDocWithDetails.autoApproveSelfInitiatedOutgoingTransfers

---

balances#

balances: BalanceArray<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1016

The user's balances.

Inherited from#

BalanceDocWithDetails.balances

---

bitbadgesAddress#

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1014

The BitBadges address of the user

Inherited from#

BalanceDocWithDetails.bitbadgesAddress

---

collectionId#

collectionId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1013

The collection ID

Inherited from#

BalanceDocWithDetails.collectionId

---

incomingApprovals#

incomingApprovals: UserIncomingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1009

The incoming approvals with details like metadata and address lists.

Inherited from#

BalanceDocWithDetails.incomingApprovals

---

outgoingApprovals#

outgoingApprovals: UserOutgoingApprovalWithDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1008

The outgoing approvals with details like metadata and address lists.

Inherited from#

BalanceDocWithDetails.outgoingApprovals

---

tags?#

optional tags?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1020

Optional tags for this balance

Inherited from#

BalanceDocWithDetails.tags

---

updateHistory#

updateHistory: UpdateHistory<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1015

The update history of this balance

Inherited from#

BalanceDocWithDetails.updateHistory

---

userPermissions#

userPermissions: UserPermissionsWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1010

The user permissions with details like metadata and address lists.

Inherited from#

BalanceDocWithDetails.userPermissions

Methods#

clone()#

clone(): BalanceDocWithDetails

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

Deep copies the object and returns a new instance.

Returns#

BalanceDocWithDetails

Inherited from#

BalanceDocWithDetails.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1043

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

BalanceDocWithDetails<U>

Inherited from#

BalanceDocWithDetails.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#

BalanceDocWithDetails.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1039

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

Returns#

string[]

Inherited from#

BalanceDocWithDetails.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#

BalanceDocWithDetails.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#

BalanceDocWithDetails.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#

BalanceDocWithDetails.toJsonString