EffectResponse

Sealed class for effect responses.

Effects represent specific changes that occur in the ledger as a result of successful operations, but are not operations themselves.

All effect types must be subclasses of this sealed class to enable polymorphic serialization. Polymorphic deserialization is handled via a custom JsonContentPolymorphicSerializer that preserves the "type" field as both a discriminator and a property.

See also

Inheritors

Types

Link copied to clipboard
@Serializable
data class EffectLinks(val operation: Link, val precedes: Link, val succeeds: Link)

Represents effect links

Properties

Link copied to clipboard
abstract val account: String?

The account address that is associated with this effect

Link copied to clipboard
@SerialName(value = "account_muxed")
abstract val accountMuxed: String?

The muxed account address that is associated with this effect

Link copied to clipboard
@SerialName(value = "account_muxed_id")
abstract val accountMuxedId: String?

The muxed account ID that is associated with this effect

Link copied to clipboard
@SerialName(value = "created_at")
abstract val createdAt: String

ISO 8601 timestamp of when this effect occurred

Link copied to clipboard
abstract val id: String

A unique identifier for this effect

Link copied to clipboard
@SerialName(value = "_links")
abstract val links: EffectResponse.EffectLinks

Links related to this effect

Link copied to clipboard
@SerialName(value = "paging_token")
abstract override val pagingToken: String

A cursor value for use in pagination

Link copied to clipboard
abstract val type: String

Type of effect