bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Type Alias AccountFetchDetails

    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.

    type AccountFetchDetails = {
        address?: NativeAddress;
        partialProfile?: boolean;
        username?: string;
        viewsToFetch?: {
            bookmark: string;
            oldestFirst?: boolean;
            specificCollections?: iBatchTokenDetails<NumberType>[];
            standard?: string;
            viewId: string;
            viewType: AccountViewKey;
        }[];
    }
    Index

    Properties

    address? partialProfile? username? viewsToFetch?

    Properties

    address?: NativeAddress

    If present, the account corresponding to the specified address will be fetched. Please only specify one of address or username.

    partialProfile?: 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

    username?: string

    If present, the account corresponding to the specified username will be fetched. Please only specify one of address or username.

    viewsToFetch?: {
        bookmark: string;
        oldestFirst?: boolean;
        specificCollections?: iBatchTokenDetails<NumberType>[];
        standard?: string;
        viewId: string;
        viewType: AccountViewKey;
    }[]

    An array of views to fetch with associated bookmarks.

    Type Declaration

    • bookmark: string

      A bookmark to pass in for pagination. "" for first request.

    • OptionaloldestFirst?: boolean

      Oldest first. By default, we fetch newest

    • OptionalspecificCollections?: iBatchTokenDetails<NumberType>[]

      If defined, we will filter the view to only include the specified collections.

    • Optionalstandard?: string

      The standard to filter by for the view.

    • viewId: string

      Unique view ID. Used for pagination. All fetches w/ same ID should be made with same criteria.

    • viewType: AccountViewKey

      The base view type to fetch.

    Settings

    Member Visibility

    On This Page

    Properties