Exception: Leash::Error

Inherits:

StandardError

• Object
• StandardError
• Leash::Error

Defined in:

lib/leash/errors.rb

Overview

Base error class for all Leash SDK errors.

Direct Known Subclasses

NotConnectedError, TokenExpiredError

Instance Attribute Summary

• #code ⇒ String^? readonly

  the error code from the platform.

• #connect_url ⇒ String^? readonly

  the OAuth connect URL (present when provider is not connected).

Instance Method Summary

• #initialize(message, code: nil, connect_url: nil) ⇒ Error constructor

  A new instance of Error.

Constructor Details

#initialize(message, code: nil, connect_url: nil) ⇒ Error

Returns a new instance of Error.

Parameters:

• message (String) —

  human-readable error message

• code (String, nil) (defaults to: nil) —

  machine-readable error code

• connect_url (String, nil) (defaults to: nil) —

  URL to initiate OAuth connection

# File 'lib/leash/errors.rb', line 14

def initialize(message, code: nil, connect_url: nil)
  super(message)
  @code = code
  @connect_url = connect_url
end

Instance Attribute Details

#code ⇒ String^? (readonly)

the error code from the platform

Returns:

• (String, nil) —

  the current value of code

# File 'lib/leash/errors.rb', line 8

def code
  @code
end

#connect_url ⇒ String^? (readonly)

the OAuth connect URL (present when provider is not connected)

Returns:

• (String, nil) —

  the current value of connect_url

# File 'lib/leash/errors.rb', line 8

def connect_url
  @connect_url
end