Class: PointsActivityDoc<T>

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

Extends#

• ActivityDoc<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iPointsActivityDoc<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iPointsActivityDoc<T>

Returns#

PointsActivityDoc<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#

iPointsActivityDoc._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#

iPointsActivityDoc._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#

iPointsActivityDoc._notificationsHandled

Inherited from#

ActivityDoc._notificationsHandled

---

applicationId#

applicationId: string

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

The application ID of the points activity

Implementation of#

iPointsActivityDoc.applicationId

---

bitbadgesAddress#

bitbadgesAddress: string

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

The BitBadges address of the user who earned the points

Implementation of#

iPointsActivityDoc.bitbadgesAddress

---

block#

block: T

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

The block number of the activity.

Implementation of#

iPointsActivityDoc.block

Inherited from#

ActivityDoc.block

---

newPoints#

newPoints: T

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

The amount of points after the activity

Implementation of#

iPointsActivityDoc.newPoints

---

oldPoints#

oldPoints: T

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

The amount of points before the activity

Implementation of#

iPointsActivityDoc.oldPoints

---

pageId#

pageId: string

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

The page ID of the points activity

Implementation of#

iPointsActivityDoc.pageId

---

timestamp#

timestamp: T

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

The timestamp of the activity.

Implementation of#

iPointsActivityDoc.timestamp

Inherited from#

ActivityDoc.timestamp

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?): PointsActivityDoc<U>

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

PointsActivityDoc<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:36

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

Returns#

string[]

Inherited from#

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