Exception: Spotify::APIError Abstract

Inherits:

Error

• Object
• StandardError
• Error
• Spotify::APIError

Extended by:

FFI::DataConverter

Defined in:

lib/spotify/error.rb

Overview

This class is abstract.

Generic error class, extended by all libspotify errors.

Direct Known Subclasses

APIInitializationFailedError, ApplicationBannedError, BadAPIVersionError, BadApplicationKeyError, BadUserAgentError, BadUsernameOrPasswordError, CantOpenTraceFileError, ClientTooOldError, InboxIsFullError, IndexOutOfRangeError, InvalidArgumentError, InvalidDeviceIdError, InvalidIndataError, IsLoadingError, LastfmAuthError, MissingCallbackError, NetworkDisabledError, NoCacheError, NoCredentialsError, NoStreamAvailableError, NoSuchUserError, OfflineDiskCacheError, OfflineExpiredError, OfflineLicenseError, OfflineLicenseLostError, OfflineNotAllowedError, OfflineTooManyTracksError, OtherPermanentError, OtherTransientError, PermissionDeniedError, SystemFailureError, TrackNotPlayableError, UnableToContactServerError, UserBannedError, UserNeedsPremiumError

Constant Summary

@@code_to_class =

{ 0 => nil }

Class Attribute Summary

• .to_i ⇒ Integer readonly

  Error code.

Class Method Summary

• .from_native(error, context) ⇒ Error^?

  Returns an error if applicable.

• .to_native(error, context) ⇒ Symbol

  From an error, retrieve it’s native value.

Instance Method Summary

• #initialize(message = "#{Spotify::API.error_message(self)} (#{to_i})") ⇒ APIError constructor

  A new instance of APIError.

• #to_i ⇒ Integer

  Error code.

Constructor Details

#initialize(message = "#{Spotify::API.error_message(self)} (#{to_i})") ⇒ APIError

Returns a new instance of APIError.

Parameters:

• message (String) (defaults to: "#{Spotify::API.error_message(self)} (#{to_i})") —

  only to be supplied if overridden

# File 'lib/spotify/error.rb', line 49

def initialize(message = "#{Spotify::API.error_message(self)} (#{to_i})")
  super
end

Class Attribute Details

.to_i ⇒ Integer (readonly)

Returns error code.

Returns:

• (Integer) —

  error code

# File 'lib/spotify/error.rb', line 38

def to_i
  @to_i
end

Class Method Details

.from_native(error, context) ⇒ Error^?

Returns an error if applicable.

Parameters:

• error (Integer)

Returns:

• (Error, nil) —

  an error, unless error symbol was OK

# File 'lib/spotify/error.rb', line 18

def from_native(error, context)
  error_class = @@code_to_class.fetch(error) do
    raise ArgumentError, "unknown error code: #{error}"
  end
  error_class.new if error_class
end

.to_native(error, context) ⇒ Symbol

From an error, retrieve it’s native value.

Parameters:

• error (Error)

Returns:

• (Symbol)

# File 'lib/spotify/error.rb', line 29

def to_native(error, context)
  if error
    error.to_i
  else
    0
  end
end

Instance Method Details

#to_i ⇒ Integer

Returns error code.

Returns:

• (Integer) —

  error code

# File 'lib/spotify/error.rb', line 54

def to_i
  self.class.to_i
end