API Documentation
\

\RippleRestTrustline

A simplified Trustline object used by the ripple-rest API

Summary

Methods
Properties
Constants
__construct()
getAccount()
setAccount()
getCounterparty()
setCounterparty()
getCurrency()
setCurrency()
getLimit()
setLimit()
getReciprocatedLimit()
setReciprocatedLimit()
getAuthorizedByAccount()
setAuthorizedByAccount()
getAuthorizedByCounterparty()
setAuthorizedByCounterparty()
getAccountAllowsRippling()
setAccountAllowsRippling()
getCounterpartyAllowsRippling()
setCounterpartyAllowsRippling()
getLedger()
setLedger()
getHash()
setHash()
getPrevious()
setPrevious()
toArray()
$account
$counterparty
$currency
$limit
$reciprocatedLimit
$authorizedByAccount
$authorizedByCounterparty
$accountAllowsRippling
$counterpartyAllowsRippling
$ledger
$hash
$previous
PATTERN_TYPE_HASH256
PATTERN_TYPE_HASH128
PATTERN_TYPE_TIMESTAMP
PATTERN_TYPE_RIPPLEADDRESS
PATTERN_TYPE_RESOURCEID
PATTERN_TYPE_FLOATSTRING
PATTERN_TYPE_URL
PATTERN_TYPE_CURRENCY
PATTERN_TYPE_UINT32
PATTERN_LEDGER
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

PATTERN_TYPE_HASH256

PATTERN_TYPE_HASH256

The hex representation of a 256-bit hash

PATTERN_TYPE_HASH128

PATTERN_TYPE_HASH128

The hex representation of a 128-bit hash

PATTERN_TYPE_TIMESTAMP

PATTERN_TYPE_TIMESTAMP

An ISO 8601 combined date and time timestamp

PATTERN_TYPE_RIPPLEADDRESS

PATTERN_TYPE_RIPPLEADDRESS

A Ripple account address

PATTERN_TYPE_RESOURCEID

PATTERN_TYPE_RESOURCEID

A client-supplied unique identifier (ideally a UUID) for this transaction used to prevent duplicate payments and help confirm the transaction's final status. All ASCII printable characters are allowed. Note that 256-bit hex strings are disallowed because of the potential confusion with transaction hashes.

PATTERN_TYPE_FLOATSTRING

PATTERN_TYPE_FLOATSTRING

A string representation of a floating point number

PATTERN_TYPE_URL

PATTERN_TYPE_URL

A standard URL

PATTERN_TYPE_CURRENCY

PATTERN_TYPE_CURRENCY

The three-character code or hex string used to denote currencies

PATTERN_TYPE_UINT32

PATTERN_TYPE_UINT32

A string representation of an unsigned 32-bit integer (0-4294967295)

PATTERN_LEDGER

PATTERN_LEDGER

Pattern Rule for field `RippleRestTrustline::$ledger`

Properties

$account

$account : string

(RippleAddress) The account from whose perspective this trustline is being viewed

Type

string

$counterparty

$counterparty : string

(RippleAddress) The other party in this trustline

Type

string

$currency

$currency : string

(Currency) The code of the currency in which this trustline denotes trust

Type

string

$limit

$limit : string

(FloatString) The maximum value of the currency that the account may hold issued by the counterparty

Type

string

$reciprocatedLimit

$reciprocatedLimit : string

(FloatString) The maximum value of the currency that the counterparty may hold issued by the account

Type

string

$authorizedByAccount

$authorizedByAccount : boolean

Set to true if the account has explicitly authorized the counterparty to hold currency it issues. This is only necessary if the account's settings include require_authorization_for_incoming_trustlines

Type

boolean

$authorizedByCounterparty

$authorizedByCounterparty : boolean

Set to true if the counterparty has explicitly authorized the account to hold currency it issues. This is only necessary if the counterparty's settings include require_authorization_for_incoming_trustlines

Type

boolean

$accountAllowsRippling

$accountAllowsRippling : boolean

If true it indicates that the account allows pairwise rippling out through this trustline

Type

boolean

$counterpartyAllowsRippling

$counterpartyAllowsRippling : boolean

If true it indicates that the counterparty allows pairwise rippling out through this trustline

Type

boolean

$ledger

$ledger : string

(/^[0-9]+$/) The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline

Type

string

$hash

$hash : string

(Hash256) If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction

Type

string

$previous

$previous : \RippleRestTrustline

If the trustline was changed this will be a full Trustline object representing the previous values. If the previous object also had a previous object that will be removed to reduce data complexity. Trustline changes can be walked backwards by querying the API for previous.hash repeatedly

Type

\RippleRestTrustline

Methods

__construct()

__construct(array $data) : \RippleRestTrustline

Create a new instance of RippleRestTrustline.

Parameters

array $data

(defaults to null) PHP Array (result of json_decode($json, true))

Returns

\RippleRestTrustline

getAccount()

getAccount() : string

The account from whose perspective this trustline is being viewed

Returns

string —

(RippleAddress)

setAccount()

setAccount(string $value) : null

The account from whose perspective this trustline is being viewed

Parameters

string $value

(RippleAddress)

Returns

null

getCounterparty()

getCounterparty() : string

The other party in this trustline

Returns

string —

(RippleAddress)

setCounterparty()

setCounterparty(string $value) : null

The other party in this trustline

Parameters

string $value

(RippleAddress)

Returns

null

getCurrency()

getCurrency() : string

The code of the currency in which this trustline denotes trust

Returns

string —

(Currency)

setCurrency()

setCurrency(string $value) : null

The code of the currency in which this trustline denotes trust

Parameters

string $value

(Currency)

Returns

null

getLimit()

getLimit() : string

The maximum value of the currency that the account may hold issued by the counterparty

Returns

string —

(FloatString)

setLimit()

setLimit(string $value) : null

The maximum value of the currency that the account may hold issued by the counterparty

Parameters

string $value

(FloatString)

Returns

null

getReciprocatedLimit()

getReciprocatedLimit() : string

The maximum value of the currency that the counterparty may hold issued by the account

Returns

string —

(FloatString)

setReciprocatedLimit()

setReciprocatedLimit(string $value) : null

The maximum value of the currency that the counterparty may hold issued by the account

Parameters

string $value

(FloatString)

Returns

null

getAuthorizedByAccount()

getAuthorizedByAccount() : boolean

Set to true if the account has explicitly authorized the counterparty to hold currency it issues. This is only necessary if the account's settings include require_authorization_for_incoming_trustlines

Returns

boolean

setAuthorizedByAccount()

setAuthorizedByAccount(boolean $value) : null

Set to true if the account has explicitly authorized the counterparty to hold currency it issues. This is only necessary if the account's settings include require_authorization_for_incoming_trustlines

Parameters

boolean $value

Returns

null

getAuthorizedByCounterparty()

getAuthorizedByCounterparty() : boolean

Set to true if the counterparty has explicitly authorized the account to hold currency it issues. This is only necessary if the counterparty's settings include require_authorization_for_incoming_trustlines

Returns

boolean

setAuthorizedByCounterparty()

setAuthorizedByCounterparty(boolean $value) : null

Set to true if the counterparty has explicitly authorized the account to hold currency it issues. This is only necessary if the counterparty's settings include require_authorization_for_incoming_trustlines

Parameters

boolean $value

Returns

null

getAccountAllowsRippling()

getAccountAllowsRippling() : boolean

If true it indicates that the account allows pairwise rippling out through this trustline

Returns

boolean

setAccountAllowsRippling()

setAccountAllowsRippling(boolean $value) : null

If true it indicates that the account allows pairwise rippling out through this trustline

Parameters

boolean $value

Returns

null

getCounterpartyAllowsRippling()

getCounterpartyAllowsRippling() : boolean

If true it indicates that the counterparty allows pairwise rippling out through this trustline

Returns

boolean

setCounterpartyAllowsRippling()

setCounterpartyAllowsRippling(boolean $value) : null

If true it indicates that the counterparty allows pairwise rippling out through this trustline

Parameters

boolean $value

Returns

null

getLedger()

getLedger() : string

The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline

Returns

string —

(/^[0-9]+$/)

setLedger()

setLedger(string $value) : null

The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline

Parameters

string $value

(/^[0-9]+$/)

Returns

null

getHash()

getHash() : string

If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction

Returns

string —

(Hash256)

setHash()

setHash(string $value) : null

If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction

Parameters

string $value

(Hash256)

Returns

null

getPrevious()

getPrevious() : \RippleRestTrustline

If the trustline was changed this will be a full Trustline object representing the previous values. If the previous object also had a previous object that will be removed to reduce data complexity. Trustline changes can be walked backwards by querying the API for previous.hash repeatedly

Returns

\RippleRestTrustline

setPrevious()

setPrevious(\RippleRestTrustline $value) : null

If the trustline was changed this will be a full Trustline object representing the previous values. If the previous object also had a previous object that will be removed to reduce data complexity. Trustline changes can be walked backwards by querying the API for previous.hash repeatedly

Parameters

\RippleRestTrustline $value

Returns

null

toArray()

toArray() : array

Convert this object to PHP native Array for serializing to JSON.

Returns

array