Notification-class: Notification class

Description Details Slots

Description

The return value from get_notification.

Details

All slot lengths must be equal.

Slots

account

Object of class "RippleAddress". The Ripple address of the account to which the notification pertains.

type

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

direction

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

state

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

result

Object of class "character". 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".

ledger

Object of class "numeric". 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.

hash

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

timestamp

Object of class "POSIXct". The timestamp representing when the transaction was validated and written into the Ripple ledger.

transaction_url

Object of class "character". An URL that can be used to fetch the full resource this notification corresponds to.

previous_notification_url

Object of class "character". An URL that can be used to fetch the notification that preceded this one chronologically.

next_notification_url

Object of class "character". An URL that can be used to fetch the notification that followed this one chronologically.


hmalmedal/ripplerestr documentation built on May 17, 2019, 4:34 p.m.