Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Effect<TN, T>

Structure representing a Stellar Effect.

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

accountId

accountId: string

The account that originates the effect.

Readonly client

client: Client

createdAt

createdAt: Date

The effect's creation date.

createdTimestamp

createdTimestamp: number

The effect's creation timestamp.

id

id: string

The id of the effect.

pagingToken

pagingToken: string

A cursor value for use in pagination.

type

type: T

The numeric type of the effect.

typeName

typeName: TN

The name of the effect type.

Methods

$patch

getAccount

  • getAccount(forceUpdate?: boolean): Promise<Account>

  • Get the account the effect belongs to.

    Parameters

    • forceUpdate: boolean = false

      If set to true, it will not check in the cache and directly make a request to retrieve the account instead.

    Returns Promise<Account>

    The account the effect belongs to.

Generated using TypeDoc