Class CurrentAccount

Current account data.

Hierarchy (View Summary)

  • DataEntity<
        {
            balance: Balances;
            email?: string;
            network: null
            | SupernetType;
            networkStatus: "connected" | "disconnected" | "connecting" | "switching";
            subscription?: SubscriptionEntitlementSnapshot;
            username?: string;
            walletAddress?: string;
        },
    >
    • CurrentAccount

Constructors

constructor

Properties

data lastUpdated listeners

Accessors

balance email isAuthenicated isUnlimited network networkStatus subscription username walletAddress

Methods

_clear emit off on once removeAllListeners toJSON

Constructors

constructor

  • new CurrentAccount(
        data?: {
            balance: Balances;
            email?: string;
            network: null | SupernetType;
            networkStatus: "connected" | "disconnected" | "connecting" | "switching";
            subscription?: SubscriptionEntitlementSnapshot;
            username?: string;
            walletAddress?: string;
        },
    ): CurrentAccount

    Parameters

    • Optionaldata: {
          balance: Balances;
          email?: string;
          network: null | SupernetType;
          networkStatus: "connected" | "disconnected" | "connecting" | "switching";
          subscription?: SubscriptionEntitlementSnapshot;
          username?: string;
          walletAddress?: string;
      }
      • balance: Balances
      • Optionalemail?: string
      • network: null | SupernetType
      • networkStatus: "connected" | "disconnected" | "connecting" | "switching"

        Current network status:

        • connected - connected to the socket
        • disconnected - disconnected from the socket
        • connecting - connecting to the socket
        • switching - switching network type (fast/relaxed)

        Default

        'disconnected'
      • Optionalsubscription?: SubscriptionEntitlementSnapshot

        The most recently fetched subscription entitlement snapshot. undefined until the account receives a socket entitlement snapshot or AccountApi.getSubscriptionStatus / AccountApi.refreshSubscription has been called.

        Subscribe to the 'updated' event (inherited from DataEntity) to react to changes; the changedKeys array will include 'subscription' when this field is refreshed.

      • Optionalusername?: string
      • OptionalwalletAddress?: string

    Returns CurrentAccount

Properties

Protecteddata

data: {
    balance: Balances;
    email?: string;
    network: null | SupernetType;
    networkStatus: "connected" | "disconnected" | "connecting" | "switching";
    subscription?: SubscriptionEntitlementSnapshot;
    username?: string;
    walletAddress?: string;
}

Type declaration

  • balance: Balances
  • Optionalemail?: string
  • network: null | SupernetType
  • networkStatus: "connected" | "disconnected" | "connecting" | "switching"

    Current network status:

    • connected - connected to the socket
    • disconnected - disconnected from the socket
    • connecting - connecting to the socket
    • switching - switching network type (fast/relaxed)

    Default

    'disconnected'
  • Optionalsubscription?: SubscriptionEntitlementSnapshot

    The most recently fetched subscription entitlement snapshot. undefined until the account receives a socket entitlement snapshot or AccountApi.getSubscriptionStatus / AccountApi.refreshSubscription has been called.

    Subscribe to the 'updated' event (inherited from DataEntity) to react to changes; the changedKeys array will include 'subscription' when this field is refreshed.

  • Optionalusername?: string
  • OptionalwalletAddress?: string

ProtectedlastUpdated

lastUpdated: Date = ...

Protectedlisteners

listeners: { updated?: (data: string[]) => void[] } = {}

Accessors

balance

email

isAuthenicated

isUnlimited

  • get isUnlimited(): boolean

    Convenience getter - true when the account has an effective subscription entitlement on any Unlimited tier ("unlimited" or "unlimited_pro").

    Returns false when no entitlement snapshot has been fetched yet, when the server reports no active entitlement, or when the tier is not an Unlimited tier. Call AccountApi.refreshSubscription to force a REST refresh when no socket entitlement snapshot has been received yet.

    Returns boolean

network

networkStatus

  • get networkStatus(): "connected" | "disconnected" | "connecting" | "switching"

    Returns "connected" | "disconnected" | "connecting" | "switching"

subscription

username

walletAddress

Methods

_clear

Protectedemit

  • emit<T extends "updated">(event: T, data: { updated: string[] }[T]): void

    Dispatch an event to all listeners

    Type Parameters

    • T extends "updated"

    Parameters

    • event: T
    • data: { updated: string[] }[T]

    Returns void

off

  • off<T extends "updated">(
        event: T,
        listener: (data: { updated: string[] }[T]) => void,
    ): void

    Remove an event listener

    Type Parameters

    • T extends "updated"

    Parameters

    • event: T
    • listener: (data: { updated: string[] }[T]) => void

    Returns void

on

  • on<T extends "updated">(
        event: T,
        listener: (data: { updated: string[] }[T]) => void,
    ): () => void

    Add an event listener, returns a function that can be called to remove the listener

    Type Parameters

    • T extends "updated"

    Parameters

    • event: T
    • listener: (data: { updated: string[] }[T]) => void

    Returns () => void

once

  • once<T extends "updated">(
        event: T,
        listener: (data: { updated: string[] }[T]) => void,
    ): () => void

    Add an event listener that will be called only once

    Type Parameters

    • T extends "updated"

    Parameters

    • event: T
    • listener: (data: { updated: string[] }[T]) => void

    Returns () => void

removeAllListeners

toJSON

  • toJSON(): {
        balance: Balances;
        email?: string;
        network: null
        | SupernetType;
        networkStatus: "connected" | "disconnected" | "connecting" | "switching";
        subscription?: SubscriptionEntitlementSnapshot;
        username?: string;
        walletAddress?: string;
    }

    Get a copy of the entity's data

    Returns {
        balance: Balances;
        email?: string;
        network: null | SupernetType;
        networkStatus: "connected" | "disconnected" | "connecting" | "switching";
        subscription?: SubscriptionEntitlementSnapshot;
        username?: string;
        walletAddress?: string;
    }

    • balance: Balances
    • Optionalemail?: string
    • network: null | SupernetType
    • networkStatus: "connected" | "disconnected" | "connecting" | "switching"

      Current network status:

      • connected - connected to the socket
      • disconnected - disconnected from the socket
      • connecting - connecting to the socket
      • switching - switching network type (fast/relaxed)

      Default

      'disconnected'
    • Optionalsubscription?: SubscriptionEntitlementSnapshot

      The most recently fetched subscription entitlement snapshot. undefined until the account receives a socket entitlement snapshot or AccountApi.getSubscriptionStatus / AccountApi.refreshSubscription has been called.

      Subscribe to the 'updated' event (inherited from DataEntity) to react to changes; the changedKeys array will include 'subscription' when this field is refreshed.

    • Optionalusername?: string
    • OptionalwalletAddress?: string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods