Class: BalanceDocWithDetails<T>
T extends NumberType
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1021
Extends
BaseNumberTypeClass<BalanceDocWithDetails<T>>
Extended by
Type Parameters
T
T extends NumberType
Implements
Constructors
Constructor
new BalanceDocWithDetails<
T>(data):BalanceDocWithDetails<T>
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1036
Parameters
data
Returns
BalanceDocWithDetails<T>
Overrides
BaseNumberTypeClass.constructor
Properties
_docId
_docId:
string
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1025
A unique stringified document ID
Implementation of
_id?
optional_id?:string
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1026
A unique document ID (Mongo DB ObjectID)
Implementation of
autoApproveAllIncomingTransfers
autoApproveAllIncomingTransfers:
boolean
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1033
Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.
Implementation of
iBalanceDocWithDetails.autoApproveAllIncomingTransfers
autoApproveSelfInitiatedIncomingTransfers
autoApproveSelfInitiatedIncomingTransfers:
boolean
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1031
Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.
Implementation of
iBalanceDocWithDetails.autoApproveSelfInitiatedIncomingTransfers
autoApproveSelfInitiatedOutgoingTransfers
autoApproveSelfInitiatedOutgoingTransfers:
boolean
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1032
Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.
Implementation of
iBalanceDocWithDetails.autoApproveSelfInitiatedOutgoingTransfers
balances
balances:
BalanceArray<T>
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1030
The user's balances.
Implementation of
iBalanceDocWithDetails.balances
bitbadgesAddress
bitbadgesAddress:
string
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1028
The BitBadges address of the user
Implementation of
iBalanceDocWithDetails.bitbadgesAddress
collectionId
collectionId:
string
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1027
The collection ID
Implementation of
iBalanceDocWithDetails.collectionId
incomingApprovals
incomingApprovals:
UserIncomingApprovalWithDetails<T>[]
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1023
The incoming approvals with details like metadata and address lists.
Implementation of
iBalanceDocWithDetails.incomingApprovals
outgoingApprovals
outgoingApprovals:
UserOutgoingApprovalWithDetails<T>[]
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1022
The outgoing approvals with details like metadata and address lists.
Implementation of
iBalanceDocWithDetails.outgoingApprovals
tags?
optionaltags?:string[]
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1034
Optional tags for this balance
Implementation of
updateHistory
updateHistory:
UpdateHistory<T>[]
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1029
The update history of this balance
Implementation of
iBalanceDocWithDetails.updateHistory
userPermissions
userPermissions:
UserPermissionsWithDetails<T>
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1024
The user permissions with details like metadata and address lists.
Implementation of
iBalanceDocWithDetails.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
convert()
convert<
U>(convertFunction,options?):BalanceDocWithDetails<U>
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1057
Converts the object to a different NumberType equivalent.
Type Parameters
U
U extends NumberType
Parameters
convertFunction
(item) => U
options?
Returns
BalanceDocWithDetails<U>
Overrides
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
getNumberFieldNames()
getNumberFieldNames():
string[]
Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1053
Internal helper method to convert the number fields of the object to a different NumberType equivalent.
Returns
string[]
Overrides
BaseNumberTypeClass.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
BaseNumberTypeClass.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
toJsonString()
toJsonString():
string
Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143
Converts the object to a JSON string.
Returns
string