Skip to content

Class: TransferActivityDoc<T>

T extends NumberType

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

Extends

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

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

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

Parameters

data

iTransferActivityDoc<T>

Returns

TransferActivityDoc<T>

Overrides

ActivityDoc.constructor

Properties

_docId

_docId: string

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

A unique stringified document ID

Implementation of

iTransferActivityDoc._docId

Inherited from

ActivityDoc._docId

_id?

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of

iTransferActivityDoc._id

Inherited from

ActivityDoc._id

_notificationsHandled?

optional _notificationsHandled?: boolean

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

Whether or not the notifications have been handled by the indexer or not.

Implementation of

iTransferActivityDoc._notificationsHandled

Inherited from

ActivityDoc._notificationsHandled

approvalsUsed?

optional approvalsUsed?: ApprovalIdentifierDetails<T>[]

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

Approvals used for the transfer

Implementation of

iTransferActivityDoc.approvalsUsed

balances

balances: BalanceArray<T>

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

The list of balances and token IDs that were transferred.

Implementation of

iTransferActivityDoc.balances

block

block: T

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

The block number of the activity.

Implementation of

iTransferActivityDoc.block

Inherited from

ActivityDoc.block

coinTransfers?

optional coinTransfers?: CoinTransferItem<T>[]

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

Coin transfers details

Implementation of

iTransferActivityDoc.coinTransfers

collectionId

collectionId: string

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

The collection ID for the tokens that was transferred.

Implementation of

iTransferActivityDoc.collectionId

denom?

optional denom?: string

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

The denomination of the transfer

Implementation of

iTransferActivityDoc.denom

from

from: string

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

The sender of the tokens.

Implementation of

iTransferActivityDoc.from

initiatedBy

initiatedBy: string

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

The user who initiated the transfer transaction.

Implementation of

iTransferActivityDoc.initiatedBy

memo?

optional memo?: string

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

The memo of the transfer.

Implementation of

iTransferActivityDoc.memo

precalculateBalancesFromApproval?

optional precalculateBalancesFromApproval?: PrecalculateBalancesFromApprovalDetails<T>

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

Which approval to use to precalculate the balances?

Implementation of

iTransferActivityDoc.precalculateBalancesFromApproval

precalculationOptions?

optional precalculationOptions?: PrecalculationOptions<T>

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

Precalculation options

Implementation of

iTransferActivityDoc.precalculationOptions

price?

optional price?: T

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

The price of the transfer

Implementation of

iTransferActivityDoc.price

prioritizedApprovals?

optional prioritizedApprovals?: ApprovalIdentifierDetails<T>[]

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

The prioritized approvals of the transfer. This is used to check certain approvals before others to ensure intended behavior.

Implementation of

iTransferActivityDoc.prioritizedApprovals

private?

optional private?: boolean

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

Only for private purposes?

Implementation of

iTransferActivityDoc.private

timestamp

timestamp: T

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

The timestamp of the activity.

Implementation of

iTransferActivityDoc.timestamp

Inherited from

ActivityDoc.timestamp

to

to: string[]

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

The list of recipients.

Implementation of

iTransferActivityDoc.to

tokenId?

optional tokenId?: T

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

The token ID for the transfer

Implementation of

iTransferActivityDoc.tokenId

txHash?

optional txHash?: string

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

The transaction hash of the activity.

Implementation of

iTransferActivityDoc.txHash

volume?

optional volume?: T

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

The volume of the transfer

Implementation of

iTransferActivityDoc.volume

Methods

clone()

clone(): ActivityDoc

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

Deep copies the object and returns a new instance.

Returns

ActivityDoc

Inherited from

ActivityDoc.clone

convert()

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

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

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

TransferActivityDoc<U>

Overrides

ActivityDoc.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

ActivityDoc.equals

getNumberFieldNames()

getNumberFieldNames(): string[]

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

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

Returns

string[]

Overrides

ActivityDoc.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

ActivityDoc.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

ActivityDoc.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

ActivityDoc.toJsonString

Edit this page on GitHub