\RippleRestAccountSettings

__construct()

__construct(array $data) : \RippleRestAccountSettings

Create a new instance of RippleRestAccountSettings.

Parameters

Returns

getAccount()

getAccount() : string

The Ripple address of the account in question

Returns

(RippleAddress)

setAccount()

setAccount(string $value) : null

The Ripple address of the account in question

Parameters

Returns

getRegularKey()

getRegularKey() : string

The hash of an optional additional public key that can be used for signing and verifying transactions

Returns

(RippleAddress)

setRegularKey()

setRegularKey(string $value) : null

The hash of an optional additional public key that can be used for signing and verifying transactions

Parameters

Returns

getUrl()

getUrl() : string

The domain associated with this account. The ripple.txt file can be looked up to verify this information

Returns

(URL)

setUrl()

setUrl(string $value) : null

The domain associated with this account. The ripple.txt file can be looked up to verify this information

Parameters

Returns

getEmailHash()

getEmailHash() : string

The MD5 128-bit hash of the account owner's email address

Returns

(Hash128)

setEmailHash()

setEmailHash(string $value) : null

The MD5 128-bit hash of the account owner's email address

Parameters

Returns

getMessageKey()

getMessageKey() : string

An optional public key, represented as hex, that can be set to allow others to send encrypted messages to the account owner

Returns

(/^([0-9a-fA-F]{2}){0,33}$/)

setMessageKey()

setMessageKey(string $value) : null

An optional public key, represented as hex, that can be set to allow others to send encrypted messages to the account owner

Parameters

Returns

getTransferRate()

getTransferRate() : float

A number representation of the rate charged each time a holder of currency issued by this account transfers it. By default the rate is 100. A rate of 101 is a 1% charge on top of the amount being transferred. Up to nine decimal places are supported

Returns

setTransferRate()

setTransferRate(float $value) : null

A number representation of the rate charged each time a holder of currency issued by this account transfers it. By default the rate is 100. A rate of 101 is a 1% charge on top of the amount being transferred. Up to nine decimal places are supported

Parameters

Returns

getRequireDestinationTag()

getRequireDestinationTag() : boolean

If set to true incoming payments will only be validated if they include a destination_tag. This may be used primarily by gateways that operate exclusively with hosted wallets

Returns

setRequireDestinationTag()

setRequireDestinationTag(boolean $value) : null

If set to true incoming payments will only be validated if they include a destination_tag. This may be used primarily by gateways that operate exclusively with hosted wallets

Parameters

Returns

getRequireAuthorization()

getRequireAuthorization() : boolean

If set to true incoming trustlines will only be validated if this account first creates a trustline to the counterparty with the authorized flag set to true. This may be used by gateways to prevent accounts unknown to them from holding currencies they issue

Returns

setRequireAuthorization()

setRequireAuthorization(boolean $value) : null

If set to true incoming trustlines will only be validated if this account first creates a trustline to the counterparty with the authorized flag set to true. This may be used by gateways to prevent accounts unknown to them from holding currencies they issue

Parameters

Returns

getDisallowXrp()

getDisallowXrp() : boolean

If set to true incoming XRP payments will be allowed

Returns

setDisallowXrp()

setDisallowXrp(boolean $value) : null

If set to true incoming XRP payments will be allowed

Parameters

Returns

getTransactionSequence()

getTransactionSequence() : string

A string representation of the last sequence number of a validated transaction created by this account

Returns

(UINT32)

setTransactionSequence()

setTransactionSequence(string $value) : null

A string representation of the last sequence number of a validated transaction created by this account

Parameters

Returns

getTrustlineCount()

getTrustlineCount() : string

The number of trustlines owned by this account. This value does not include incoming trustlines where this account has not explicitly reciprocated trust

Returns

(UINT32)

setTrustlineCount()

setTrustlineCount(string $value) : null

The number of trustlines owned by this account. This value does not include incoming trustlines where this account has not explicitly reciprocated trust

Parameters

Returns

getLedger()

getLedger() : string

The string representation of the index number of the ledger containing these account settings or, in the case of historical queries, of the transaction that modified these settings

Returns

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

setLedger()

setLedger(string $value) : null

The string representation of the index number of the ledger containing these account settings or, in the case of historical queries, of the transaction that modified these settings

Parameters

Returns

getHash()

getHash() : string

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

Returns

(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 these settings. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction

Parameters

Returns

toArray()

toArray() : array

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

Returns