io.token

Class Account

java.lang.Object

io.token.Account

public class Account
extends java.lang.Object

Represents a funding account in the Token system.

Method Summary

Modifier and Type	Method and Description
AccountAsync	async() Returns an async version of the API.
java.lang.String	bankId() Gets a bank ID.
boolean	equals(java.lang.Object obj)
io.token.proto.common.money.MoneyProtos.Money	getAvailableBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up an account available balance.
io.token.proto.common.transaction.TransactionProtos.Balance	getBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up an account balance.
io.token.proto.common.money.MoneyProtos.Money	getCurrentBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Looks up an account current balance.
io.token.proto.common.transaction.TransactionProtos.Transaction	getTransaction(java.lang.String transactionId, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Lookup transaction.
io.token.proto.PagedList<io.token.proto.common.transaction.TransactionProtos.Transaction,java.lang.String>	getTransactions(java.lang.String offset, int limit, io.token.proto.common.security.SecurityProtos.Key.Level keyLevel) Lookup transactions.
int	hashCode()
java.lang.String	id() Gets an account id.
boolean	isDefault() Checks if this account is default.
boolean	isLocked() Looks up if this account is locked.
Member	member() Gets a sync version of the Member API.
java.lang.String	name() Gets an account name.
void	setAsDefault() Sets to be a default account for its member.
io.token.proto.common.account.AccountProtos.Account	toProto() Fetches the original AccountProtos.Account object.

Methods inherited from class java.lang.Object

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

Method Detail

async

public AccountAsync async()

Returns an async version of the API.

Returns:

asynchronous version of the account API

member

public Member member()

Gets a sync version of the Member API.

Returns:

account owner

id

public java.lang.String id()

Gets an account id.

Returns:

account id

setAsDefault

public void setAsDefault()

Sets to be a default account for its member. Only 1 account can be default for each member.

isDefault

public boolean isDefault()

Checks if this account is default.

Returns:

true if the account is default; otherwise false

name

public java.lang.String name()

Gets an account name.

Returns:

account name

bankId

public java.lang.String bankId()

Gets a bank ID.

Returns:

bank ID

isLocked

public boolean isLocked()

Looks up if this account is locked.

Returns:

true if this account is locked; false otherwise.

toProto

public io.token.proto.common.account.AccountProtos.Account toProto()

Fetches the original AccountProtos.Account object.

Returns:

the account.

getBalance

public io.token.proto.common.transaction.TransactionProtos.Balance getBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up an account balance.

Parameters:

keyLevel - key level

Returns:

account balance

getCurrentBalance

public io.token.proto.common.money.MoneyProtos.Money getCurrentBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up an account current balance.

Parameters:

keyLevel - key level

Returns:

account current balance

getAvailableBalance

public io.token.proto.common.money.MoneyProtos.Money getAvailableBalance(io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Looks up an account available balance.

Parameters:

keyLevel - key level

Returns:

account available balance

getTransaction

public io.token.proto.common.transaction.TransactionProtos.Transaction getTransaction(java.lang.String transactionId,
                                                                                      io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Lookup transaction.

Parameters:

transactionId - transaction id

keyLevel - key level

Returns:

transaction

getTransactions

public io.token.proto.PagedList<io.token.proto.common.transaction.TransactionProtos.Transaction,java.lang.String> getTransactions(@Nullable
                                                                                                                                  java.lang.String offset,
                                                                                                                                  int limit,
                                                                                                                                  io.token.proto.common.security.SecurityProtos.Key.Level keyLevel)

Lookup transactions.

Parameters:

offset - offset

limit - limit

keyLevel - key level

Returns:

paged list of transactions

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object