Class: EmailVerificationStatus<T>

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

The verification status of the user's email.

Extends#

• BaseNumberTypeClass<EmailVerificationStatus<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iEmailVerificationStatus<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iEmailVerificationStatus<T>

Returns#

EmailVerificationStatus<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

antiPhishingCode?#

optional antiPhishingCode?: string

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

A unique code that we will send with all emails to verify that BitBadges is the one sending the email.

Implementation of#

iEmailVerificationStatus.antiPhishingCode

---

expiry?#

optional expiry?: T

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

The expiry of the token for verification purposes.

Implementation of#

iEmailVerificationStatus.expiry

---

token?#

optional token?: string

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

The email verification token. This is used for verification and unsubscription.

Implementation of#

iEmailVerificationStatus.token

---

verified?#

optional verified?: boolean

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

Whether or not the email has been verified.

Implementation of#

iEmailVerificationStatus.verified

---

verifiedAt?#

optional verifiedAt?: T

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

Verified at timestamp.

Implementation of#

iEmailVerificationStatus.verifiedAt

Methods#

clone()#

clone(): EmailVerificationStatus

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

Deep copies the object and returns a new instance.

Returns#

EmailVerificationStatus

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

EmailVerificationStatus<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/api-indexer/docs-types/docs.ts:512

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#

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