Type Alias AccountFetchDetails

AccountFetchDetails: {
    address?: NativeAddress;
    fetchBalance?: boolean;
    fetchSequence?: boolean;
    noExternalCalls?: boolean;
    partialProfile?: boolean;
    username?: string;
    viewsToFetch?: {
        bookmark: string;
        oldestFirst?: boolean;
        specificCollections?: iBatchBadgeDetails<NumberType>[];
        specificLists?: string[];
        viewId: string;
        viewType: AccountViewKey;
    }[];
}

This defines the options for fetching additional account details.

A view is a way of fetching additional details about an account, and these will be queryable in the response via the views property.

Each view has a bookmark that is used for pagination and must be supplied to get the next page.

We support the following views:

  • transferActivity - Fetches the latest activity for the account.
  • latestAnnouncements - Fetches the latest announcements for the account.
  • reviews - Fetches the latest reviews for the account.
  • badgesCollected - Fetches the badges collected by the account sequentially in random order.

Type declaration

  • Optionaladdress?: NativeAddress

    The address of the user. This can be their native address. Only one of address or username should be specified.

  • OptionalfetchBalance?: boolean

    If true, we will fetch the $BADGE balance from the blockchain.

  • OptionalfetchSequence?: boolean

    If true, we will fetch the sequence from the blockchain.

  • OptionalnoExternalCalls?: boolean

    If true, we will avoid external API calls.

  • OptionalpartialProfile?: boolean

    If true, we will only fetch a partial set of the document for the user.

    Currently includes: solAddress, username, profile pic, and latest signed in chain

    Pretty much, anything you need to display the address but not the full profile

  • Optionalusername?: string

    The username of the user. Only one of address or username should be specified.

  • OptionalviewsToFetch?: {
        bookmark: string;
        oldestFirst?: boolean;
        specificCollections?: iBatchBadgeDetails<NumberType>[];
        specificLists?: string[];
        viewId: string;
        viewType: AccountViewKey;
    }[]

    An array of views to fetch

Settings

Member Visibility