Class: RippleRest::Notifications

Inherits:
Object
  • Object
show all
Defined in:
lib/ripple-rest/helpers.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#accountAccount

Returns:


87
88
89
# File 'lib/ripple-rest/helpers.rb', line 87

def 
  @account
end

Instance Method Details

#[](hash) ⇒ Notification

Get notifications.

Clients using notifications to monitor their account activity should pay particular attention to the `state` and `result` fields. The `state` field will either be `validated` or `failed` and represents the finalized status of that transaction. The `result` field will be `tesSUCCESS` if the `state` was validated. If the transaction failed, `result` will contain the `rippled` or `ripple-lib` error code.

Notifications have `next_notification_url` and `previous_notification_url`'s. Account notifications can be polled by continuously following the `next_notification_url`, and handling the resultant notifications, until the `next_notification_url` is an empty string. This means that there are no new notifications but, as soon as there are, querying the same URL that produced this notification in the first place will return the same notification but with the `next_notification_url` set.

Returns:

Raises:


97
98
99
100
# File 'lib/ripple-rest/helpers.rb', line 97

def [] hash
  Notification.new RippleRest
    .get("v1/accounts/#{.address}/notifications/#{hash}")["notification"]
end