Package org.onyx.api

Class Action

java.lang.Object

org.onyx.api.Action

public class Action
extends Object

Action queries are designed to provide insights into those actions. There are two types of queries you can run against them; one is "ListBuilder", one is "SumBuilder". ListBuilder simply returns a list of Action objects that match the filter; SumBuilder sums over the amount fields based on the filter and the groupBy param and returns ActionSum objects. Please refer to ActionSum class for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Action.ItemIterable	Iterable interface for consuming individual actions from a query.
static class	Action.ListBuilder	A builder class for querying actions in the ledger.
static class	Action.Page	A single page of actions returned from a query.
static class	Action.Snapshot
static class	Action.SumBuilder	A builder class for querying actionsums in the ledger.
static class	Action.TagUpdateBuilder	A builder for updating an action's tags.

Field Summary

Fields

Modifier and Type	Field	Description
long	amount	The number of units of the action's asset
String	assetId	The ID of the asset held by the action.
String	destinationAccountId	The ID of the destination account affected by the action.
String	id	A unique ID.
Action.Snapshot	snapshot	A copy of the associated tags (asset, source account, destination account, action, and token) as they existed at the time of the transaction.
String	sourceAccountId	The ID of the source account executing the action.
Map<String,Object>	tags	User-specified key-value data embedded in the action.
Date	timestamp	Time of the action.
String	transactionId	The ID of the transaction in which the action appears.
String	type	The type of the action.

Constructor Summary

Constructors

Constructor	Description
Action()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

amount

@Expose
public long amount

The number of units of the action's asset

type

@Expose
public String type

The type of the action. Currently, there are three options: "issue", "transfer", "retire".

id

@Expose
public String id

A unique ID.

transactionId

@SerializedName("transaction_id")
@Expose
public String transactionId

The ID of the transaction in which the action appears.

timestamp

@Expose
public Date timestamp

Time of the action.

assetId

@SerializedName("asset_id")
@Expose
public String assetId

The ID of the asset held by the action.

snapshot

@SerializedName("snapshot")
@Expose
public Action.Snapshot snapshot

A copy of the associated tags (asset, source account, destination account, action, and token) as they existed at the time of the transaction.

sourceAccountId

@SerializedName("source_account_id")
@Expose
public String sourceAccountId

The ID of the source account executing the action.

destinationAccountId

@SerializedName("destination_account_id")
@Expose
public String destinationAccountId

The ID of the destination account affected by the action.

tags

@SerializedName("tags")
@Expose
public Map<String,Object> tags

User-specified key-value data embedded in the action.

Constructor Details

Action

public Action()