Interface iProfileDoc<T>

interface iProfileDoc<T> {
    _docId: string;
    _id?: string;
    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;
        };
    };
    bannerImage?: string;
    createdAt?: T;
    customLinks?: iCustomLink[];
    customPages?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<T>[];
        lists: iCustomListPage[];
    };
    discord?: string;
    embeddedWalletAddress?: string;
    fetchedProfile?: "full" | "partial";
    github?: string;
    hiddenBadges?: iBatchBadgeDetails<T>[];
    hiddenLists?: string[];
    latestSignedInChain?: SupportedChain;
    notifications?: iNotificationPreferences<T>;
    profilePicUrl?: string;
    readme?: string;
    seenActivity?: T;
    socialConnections?: iSocialConnections<T>;
    solAddress?: string;
    telegram?: string;
    twitter?: string;
    username?: string;
    watchlists?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<T>[];
        lists: iCustomListPage[];
    };
}

Type Parameters

Hierarchy (view full)

Implemented by

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?

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: iCustomListPage[];
    badges: iCustomPage<T>[];
    lists: iCustomListPage[];
}

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?: iBatchBadgeDetails<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?: iNotificationPreferences<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?: iSocialConnections<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: iCustomListPage[];
    badges: iCustomPage<T>[];
    lists: iCustomListPage[];
}

The watched lists of the account's portfolio

Settings

Member Visibility

On This Page

Properties