Class: NotificationPreferences<T>

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

Details about the user's push notification preferences.

Extends#

• BaseNumberTypeClass<NotificationPreferences<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iNotificationPreferences<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iNotificationPreferences<T>

Returns#

NotificationPreferences<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

discord?#

optional discord?: object

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

The Discord ID to receive push notifications.

discriminator#

discriminator: string | undefined

id#

id: string

token#

token: string

username#

username: string

Implementation of#

iNotificationPreferences.discord

---

email?#

optional email?: string

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

The email to receive push notifications.

Implementation of#

iNotificationPreferences.email

---

emailVerification?#

optional emailVerification?: EmailVerificationStatus<T>

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

The verification status of the email.

Implementation of#

iNotificationPreferences.emailVerification

---

preferences?#

optional preferences?: object

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

The preferences for the notifications. What type of notifications does the user want to receive?

claimActivity?#

optional claimActivity?: boolean

ignoreIfInitiator?#

optional ignoreIfInitiator?: boolean

signInAlertsEnabled?#

optional signInAlertsEnabled?: boolean

transferActivity?#

optional transferActivity?: boolean

Implementation of#

iNotificationPreferences.preferences

Methods#

clone()#

clone(): NotificationPreferences

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

Deep copies the object and returns a new instance.

Returns#

NotificationPreferences

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

NotificationPreferences<U>

Overrides#

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

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

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#

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

BaseNumberTypeClass.toJsonString