Exception: Skyfall::SubscriptionError

Inherits:
Error
  • Object
show all
Defined in:
lib/skyfall/errors.rb

Overview

Raised when the server sends a message which is formatted correctly, but describes some kind of error condition that the server has detected.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_type, error_message = nil) ⇒ SubscriptionError

Returns a new instance of SubscriptionError.

Parameters:

  • a short machine-readable error code

  • (defaults to: nil)

    a human-readable error message



58
59
60
61
62
63
 
# File 'lib/skyfall/errors.rb', line 58

def initialize(error_type, error_message = nil)
  @error_type = error_type
  @error_message = error_message

  super("Subscription error: #{error_type}" + (error_message ? " (#{error_message})" : ""))
end

Instance Attribute Details

#error_message ⇒ String (readonly)

Returns a human-readable error message.

Returns:

  • a human-readable error message



52
53
54
 
# File 'lib/skyfall/errors.rb', line 52

def error_message
  @error_message
end

#error_type ⇒ String (readonly)

Returns a short machine-readable error code.

Returns:

  • a short machine-readable error code



49
50
51
 
# File 'lib/skyfall/errors.rb', line 49

def error_type
  @error_type
end