Type Alias User

User: {
    avatarUrl?: string;
    balances: Kv<bigint>;
    coins: number;
    createTime?: string;
    displayName?: string;
    id?: string;
    lang_tag?: string;
    location?: string;
    meta: any;
    metadata?: string;
    online?: boolean;
    timezone?: string;
    username?: string;
    walletAddr: Web3Address | null;
}

The User type describes a user account.

Type declaration

  • OptionalavatarUrl?: string

    The user's avatar URL.

  • balances: Kv<bigint>

    Balances of other off-chain coins.

  • coins: number

    The user's coin balance.

  • OptionalcreateTime?: string

    The user's creation time.

  • OptionaldisplayName?: string

    The user's display name.

  • Optionalid?: string

    A unique id for this user.

  • Optionallang_tag?: string

    The user's language tag, if specified.

  • Optionallocation?: string

    A rough location of the user, if consent was given.

  • meta: any

    Additional metadata about the user, safely parsed from the metadata field.

  • Optionalmetadata?: string

    Raw, additional metadata about the user.

  • Optionalonline?: boolean

    Whether the user is currently online.

  • Optionaltimezone?: string

    The user's timezone.

  • Optionalusername?: string

    The user's username.

  • walletAddr: Web3Address | null

    For accounts with connected wallets, the wallet address.

Settings

Member Visibility