API Documentation
\

\RippleRestNotification

A

Summary

Methods
Properties
Constants
__construct()
getAccount()
setAccount()
getType()
setType()
getDirection()
setDirection()
getState()
setState()
getResult()
setResult()
getLedger()
setLedger()
getHash()
setHash()
getTimestamp()
setTimestamp()
getTransactionUrl()
setTransactionUrl()
getPreviousNotificationUrl()
setPreviousNotificationUrl()
getNextNotificationUrl()
setNextNotificationUrl()
toArray()
$account
$type
$direction
$state
$result
$ledger
$hash
$timestamp
$transactionUrl
$previousNotificationUrl
$nextNotificationUrl
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_TYPE
PATTERN_DIRECTION
PATTERN_STATE
PATTERN_RESULT
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_TYPE

PATTERN_TYPE

Pattern Rule for field `RippleRestNotification::$type`

PATTERN_DIRECTION

PATTERN_DIRECTION

Pattern Rule for field `RippleRestNotification::$direction`

PATTERN_STATE

PATTERN_STATE

Pattern Rule for field `RippleRestNotification::$state`

PATTERN_RESULT

PATTERN_RESULT

Pattern Rule for field `RippleRestNotification::$result`

PATTERN_LEDGER

PATTERN_LEDGER

Pattern Rule for field `RippleRestNotification::$ledger`

Properties

$account

$account : string

(RippleAddress) The Ripple address of the account to which the notification pertains

Type

string

$type

$type : string

(/^payment|order|trustline|accountsettings$/) The resource type this notification corresponds to. Possible values are "payment", "order", "trustline", "accountsettings"

Type

string

$direction

$direction : string

(/^incoming|outgoing|passthrough$/) The direction of the transaction, from the perspective of the account being queried. Possible values are "incoming", "outgoing", and "passthrough"

Type

string

$state

$state : string

(/^validated|failed$/) The state of the transaction from the perspective of the Ripple Ledger. Possible values are "validated" and "failed"

Type

string

$result

$result : string

(/te[cfjlms][A-Za-z_]+/) The rippled code indicating the success or failure type of the transaction. The code "tesSUCCESS" indicates that the transaction was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"

Type

string

$ledger

$ledger : string

(/^[0-9]+$/) The string representation of the index number of the ledger containing the validated or failed transaction. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed

Type

string

$hash

$hash : string

(Hash256) The 256-bit hash of the transaction. This is used throughout the Ripple protocol as the unique identifier for the transaction

Type

string

$timestamp

$timestamp : string

(Timestamp) The timestamp representing when the transaction was validated and written into the Ripple ledger

Type

string

$transactionUrl

$transactionUrl : string

A URL that can be used to fetch the full resource this notification corresponds to

Type

string

$previousNotificationUrl

$previousNotificationUrl : string

A URL that can be used to fetch the notification that preceded this one chronologically

Type

string

$nextNotificationUrl

$nextNotificationUrl : string

A URL that can be used to fetch the notification that followed this one chronologically

Type

string

Methods

__construct()

__construct(array $data) : \RippleRestNotification

Create a new instance of RippleRestNotification.

Parameters

array $data

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

Returns

\RippleRestNotification

getAccount()

getAccount() : string

The Ripple address of the account to which the notification pertains

Returns

string —

(RippleAddress)

setAccount()

setAccount(string $value) : null

The Ripple address of the account to which the notification pertains

Parameters

string $value

(RippleAddress)

Returns

null

getType()

getType() : string

The resource type this notification corresponds to. Possible values are "payment", "order", "trustline", "accountsettings"

Returns

string —

(/^payment|order|trustline|accountsettings$/)

setType()

setType(string $value) : null

The resource type this notification corresponds to. Possible values are "payment", "order", "trustline", "accountsettings"

Parameters

string $value

(/^payment|order|trustline|accountsettings$/)

Returns

null

getDirection()

getDirection() : string

The direction of the transaction, from the perspective of the account being queried. Possible values are "incoming", "outgoing", and "passthrough"

Returns

string —

(/^incoming|outgoing|passthrough$/)

setDirection()

setDirection(string $value) : null

The direction of the transaction, from the perspective of the account being queried. Possible values are "incoming", "outgoing", and "passthrough"

Parameters

string $value

(/^incoming|outgoing|passthrough$/)

Returns

null

getState()

getState() : string

The state of the transaction from the perspective of the Ripple Ledger. Possible values are "validated" and "failed"

Returns

string —

(/^validated|failed$/)

setState()

setState(string $value) : null

The state of the transaction from the perspective of the Ripple Ledger. Possible values are "validated" and "failed"

Parameters

string $value

(/^validated|failed$/)

Returns

null

getResult()

getResult() : string

The rippled code indicating the success or failure type of the transaction. The code "tesSUCCESS" indicates that the transaction was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"

Returns

string —

(/te[cfjlms][A-Za-z_]+/)

setResult()

setResult(string $value) : null

The rippled code indicating the success or failure type of the transaction. The code "tesSUCCESS" indicates that the transaction was successfully validated and written into the Ripple Ledger. All other codes will begin with the following prefixes: "tec", "tef", "tel", or "tej"

Parameters

string $value

(/te[cfjlms][A-Za-z_]+/)

Returns

null

getLedger()

getLedger() : string

The string representation of the index number of the ledger containing the validated or failed transaction. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed

Returns

string —

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

setLedger()

setLedger(string $value) : null

The string representation of the index number of the ledger containing the validated or failed transaction. Failed payments will only be written into the Ripple Ledger if they fail after submission to a rippled and a Ripple Network fee is claimed

Parameters

string $value

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

Returns

null

getHash()

getHash() : string

The 256-bit hash of the transaction. This is used throughout the Ripple protocol as the unique identifier for the transaction

Returns

string —

(Hash256)

setHash()

setHash(string $value) : null

The 256-bit hash of the transaction. This is used throughout the Ripple protocol as the unique identifier for the transaction

Parameters

string $value

(Hash256)

Returns

null

getTimestamp()

getTimestamp() : string

The timestamp representing when the transaction was validated and written into the Ripple ledger

Returns

string —

(Timestamp)

setTimestamp()

setTimestamp(string $value) : null

The timestamp representing when the transaction was validated and written into the Ripple ledger

Parameters

string $value

(Timestamp)

Returns

null

getTransactionUrl()

getTransactionUrl() : string

A URL that can be used to fetch the full resource this notification corresponds to

Returns

string

setTransactionUrl()

setTransactionUrl(string $value) : null

A URL that can be used to fetch the full resource this notification corresponds to

Parameters

string $value

Returns

null

getPreviousNotificationUrl()

getPreviousNotificationUrl() : string

A URL that can be used to fetch the notification that preceded this one chronologically

Returns

string

setPreviousNotificationUrl()

setPreviousNotificationUrl(string $value) : null

A URL that can be used to fetch the notification that preceded this one chronologically

Parameters

string $value

Returns

null

getNextNotificationUrl()

getNextNotificationUrl() : string

A URL that can be used to fetch the notification that followed this one chronologically

Returns

string

setNextNotificationUrl()

setNextNotificationUrl(string $value) : null

A URL that can be used to fetch the notification that followed this one chronologically

Parameters

string $value

Returns

null

toArray()

toArray() : array

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

Returns

array