Skip to content

Class: ProfileDoc<T>

T extends NumberType

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

Extends

Extended by

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

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

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

Parameters

data

iProfileDoc<T>

Returns

ProfileDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

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

A unique stringified document ID

Implementation of

iProfileDoc._docId

_id?

optional _id?: string

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

A unique document ID (Mongo DB ObjectID)

Implementation of

iProfileDoc._id

bannerImage?

optional bannerImage?: string

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

The banner image URL of the account

Implementation of

iProfileDoc.bannerImage

createdAt?

optional createdAt?: T

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

The timestamp of when this account was created (milliseconds since epoch)

Implementation of

iProfileDoc.createdAt

discord?

optional discord?: string

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

The Discord username of the account

Implementation of

iProfileDoc.discord

fetchedProfile?

optional fetchedProfile?: "full" | "partial"

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

Whether we have already fetched the profile or not

Implementation of

iProfileDoc.fetchedProfile

github?

optional github?: string

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

The GitHub username of the account

Implementation of

iProfileDoc.github

hiddenTokens?

optional hiddenTokens?: BatchTokenDetailsArray<T>

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

The hidden tokens of the account

Implementation of

iProfileDoc.hiddenTokens

latestSignedInChain?

optional latestSignedInChain?: SupportedChain

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

The latest chain the user signed in with

Implementation of

iProfileDoc.latestSignedInChain

notifications?

optional notifications?: NotificationPreferences<T>

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

The notifications of the account

Implementation of

iProfileDoc.notifications

profilePicUrl?

optional profilePicUrl?: string

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

The profile picture URL of the account

Implementation of

iProfileDoc.profilePicUrl

readme?

optional readme?: string

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

The readme of the account

Implementation of

iProfileDoc.readme

seenActivity?

optional seenActivity?: T

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

The timestamp of the last activity seen for this account (milliseconds since epoch)

Implementation of

iProfileDoc.seenActivity

telegram?

optional telegram?: string

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

The Telegram username of the account

Implementation of

iProfileDoc.telegram

twitter?

optional twitter?: string

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

The Twitter username of the account

Implementation of

iProfileDoc.twitter

username?

optional username?: string

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

The username of the account

Implementation of

iProfileDoc.username

Methods

clone()

clone(): ProfileDoc

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

Deep copies the object and returns a new instance.

Returns

ProfileDoc

Inherited from

BaseNumberTypeClass.clone

convert()

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

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

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

ProfileDoc<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:584

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

Edit this page on GitHub