Class ProfileDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_docId _id? approvedSignInMethods? bannerImage? createdAt? customLinks? customPages? discord? embeddedWalletAddress? fetchedProfile? github? hiddenBadges? hiddenLists? latestSignedInChain? notifications? profilePicUrl? readme? seenActivity? socialConnections? solAddress? telegram? twitter? username? watchlists?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

OptionalapprovedSignInMethods

approvedSignInMethods?: {
    addresses?: {
        address: string;
        scopes: OAuthScopeDetails[];
    }[];
    discord?: {
        discriminator?: string;
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    github?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    google?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    passwords?: {
        passwordHash: string;
        salt: string;
        scopes: OAuthScopeDetails[];
    }[];
    twitter?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
}

Approved ways to sign in

OptionalbannerImage

bannerImage?: string

The banner image URL of the account

OptionalcreatedAt

createdAt?: T

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

OptionalcustomLinks

customLinks?: iCustomLink[]

The custom links of the account

OptionalcustomPages

customPages?: {
    attestations: CustomListPage[];
    badges: CustomPage<T>[];
    lists: CustomListPage[];
}

The custom pages of the account

Optionaldiscord

discord?: string

The Discord username of the account

OptionalembeddedWalletAddress

embeddedWalletAddress?: string

Embedded wallet address

OptionalfetchedProfile

fetchedProfile?: "full" | "partial"

Whether we have already fetched the profile or not

Optionalgithub

github?: string

The GitHub username of the account

OptionalhiddenBadges

hiddenBadges?: BatchBadgeDetailsArray<T>

The hidden badges of the account

OptionalhiddenLists

hiddenLists?: string[]

The hidden lists of the account

OptionallatestSignedInChain

latestSignedInChain?: SupportedChain

The latest chain the user signed in with

Optionalnotifications

notifications?: NotificationPreferences<T>

The notifications of the account

OptionalprofilePicUrl

profilePicUrl?: string

The profile picture URL of the account

Optionalreadme

readme?: string

The readme of the account

OptionalseenActivity

seenActivity?: T

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

OptionalsocialConnections

socialConnections?: SocialConnections<T>

Social connections stored for the account

OptionalsolAddress

solAddress?: string

The Solana address of the profile, if applicable (bc we need it to convert)

Optionaltelegram

telegram?: string

The Telegram username of the account

Optionaltwitter

twitter?: string

The Twitter username of the account

Optionalusername

username?: string

The username of the account

Optionalwatchlists

watchlists?: {
    attestations: CustomListPage[];
    badges: CustomPage<T>[];
    lists: CustomListPage[];
}

The watched lists of the account's portfolio

Methods

clone

convert

equals

  • equals<U>(other, normalizeNumberTypes?): boolean

  • 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

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

hasNumberFields

toJson

toJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods