Class: RippleRest::Notification

Inherits:
RestObject show all
Defined in:
lib/ripple-rest/generated-schemas.rb,
lib/ripple-rest/generated-schemas.rb

Overview

A

Instance Attribute Summary collapse

Method Summary

Methods inherited from RestObject

#initialize, #to_hash

Constructor Details

This class inherits a constructor from RippleRest::RestObject

Instance Attribute Details

#accountString<RippleAddress>

The Ripple address of the account to which the notification pertains

Returns:

  • (String<RippleAddress>)

28
# File 'lib/ripple-rest/generated-schemas.rb', line 28

property :account, :RippleAddress

#directionString

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$”


38
# File 'lib/ripple-rest/generated-schemas.rb', line 38

property :direction, [:String, "^incoming|outgoing|passthrough$"]

#hashString<Hash256>

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

Returns:

  • (String<Hash256>)

58
# File 'lib/ripple-rest/generated-schemas.rb', line 58

property :hash, :Hash256

#ledgerString

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]$”+


53
# File 'lib/ripple-rest/generated-schemas.rb', line 53

property :ledger, [:String, "^[0-9]+$"]

#next_notification_urlString

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

Returns:

  • (String)

78
# File 'lib/ripple-rest/generated-schemas.rb', line 78

property :next_notification_url, :String

#previous_notification_urlString

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

Returns:

  • (String)

73
# File 'lib/ripple-rest/generated-schemas.rb', line 73

property :previous_notification_url, :String

#resultString

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[A-Za-z_]”+


48
# File 'lib/ripple-rest/generated-schemas.rb', line 48

property :result, [:String, "te[cfjlms][A-Za-z_]+"]

#stateString

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

Returns:

  • (String)

    “^validated|failed$”


43
# File 'lib/ripple-rest/generated-schemas.rb', line 43

property :state, [:String, "^validated|failed$"]

#timestampTime

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

Returns:

  • (Time)

63
# File 'lib/ripple-rest/generated-schemas.rb', line 63

property :timestamp, :Timestamp

#transaction_urlString

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

Returns:

  • (String)

68
# File 'lib/ripple-rest/generated-schemas.rb', line 68

property :transaction_url, :String

#typeString

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

Returns:

  • (String)

    “^payment|order|trustline|accountsettings$”


33
# File 'lib/ripple-rest/generated-schemas.rb', line 33

property :type, [:String, "^payment|order|trustline|accountsettings$"]