Class ProfileDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

Properties

_docId

_docId: string

A unique stringified document ID

Optional _id

_id?: string

A unique document ID (Mongo DB ObjectID)

Optional approvedSignInMethods

approvedSignInMethods?: {
    discord?: {
        discriminator?: string;
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    github?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    google?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    twitter?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
}

Approved ways to sign in

Type declaration

  • Optional discord?: {
        discriminator?: string;
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    }
  • Optional github?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    }
  • Optional google?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    }
  • Optional twitter?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    }

Optional createdAt

createdAt?: T

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

Optional customLinks

customLinks?: iCustomLink[]

The custom links of the account

Optional customPages

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

The custom pages of the account

Type declaration

Optional discord

discord?: string

The Discord username of the account

Optional fetchedProfile

fetchedProfile?: boolean

Whether we have already fetched the profile or not

Optional github

github?: string

The GitHub username of the account

Optional hiddenBadges

hiddenBadges?: BatchBadgeDetailsArray<T>

The hidden badges of the account

Optional hiddenLists

hiddenLists?: string[]

The hidden lists of the account

Optional latestSignedInChain

latestSignedInChain?: SupportedChain

The latest chain the user signed in with

Optional notifications

notifications?: NotificationPreferences<T>

The notifications of the account

Optional profilePicUrl

profilePicUrl?: string

The profile picture URL of the account

Optional readme

readme?: string

The readme of the account

Optional seenActivity

seenActivity?: T

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

Optional socialConnections

socialConnections?: SocialConnections<T>

Social connections stored for the account

Optional solAddress

solAddress?: string

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

Optional telegram

telegram?: string

The Telegram username of the account

Optional twitter

twitter?: string

The Twitter username of the account

Optional username

username?: string

The username of the account

Optional watchlists

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

The watched lists of the account's portfolio

Type declaration

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>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

toJson

toJsonString

Settings

Member Visibility

Theme

On This Page

constructor_docId_idapprovedSignInMethodscreatedAtcustomLinkscustomPagesdiscordfetchedProfilegithubhiddenBadgeshiddenListslatestSignedInChainnotificationsprofilePicUrlreadmeseenActivitysocialConnectionssolAddresstelegramtwitterusernamewatchlistscloneconvertequalsgetNumberFieldNamestoJsontoJsonString