Class: Harkness::Base::DataWrapper

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::Base::DataWrapper

Defined in:

lib/harkness/models/base/data_wrapper.rb

Overview

The top level wrapper of a response from the API.

Direct Known Subclasses

CharacterDataWrapper, ComicDataWrapper, CreatorDataWrapper, EventDataWrapper, SeriesDataWrapper, StoryDataWrapper

Instance Attribute Summary

• #attributionHTML ⇒ String readonly

  An HTML representation of the attribution notice for this result.

• #attributionText ⇒ String readonly

  The attribution notice for this result.

• #code ⇒ Integer readonly

  The HTTP status code of the returned result.

• #copyright ⇒ String readonly

  The copyright notice for the returned result.

• #data ⇒ Harkness::Base::DataContainer readonly

  The results returned by the call.

• #etag ⇒ String readonly

  A digest value of the content returned by the call.

• #status ⇒ String readonly

  A string description of the call status.

Instance Attribute Details

#attributionHTML ⇒ String (readonly)

Returns an HTML representation of the attribution notice for this result. Please display either this notice or the contents of the attributionText field on all screens which contain data from the Marvel Comics API.

Returns:

• (String) —

  an HTML representation of the attribution notice for this result. Please display either this notice or the contents of the attributionText field on all screens which contain data from the Marvel Comics API.

# File 'lib/harkness/models/base/data_wrapper.rb', line 25

attribute :attributionHTML, Shale::Type::String

#attributionText ⇒ String (readonly)

Returns the attribution notice for this result. Please display either this notice or the contents of the attributionHTML field on all screens which contain data from the Marvel Comics API.

Returns:

• (String) —

  the attribution notice for this result. Please display either this notice or the contents of the attributionHTML field on all screens which contain data from the Marvel Comics API.

# File 'lib/harkness/models/base/data_wrapper.rb', line 20

attribute :attributionText, Shale::Type::String

#code ⇒ Integer (readonly)

Returns the HTTP status code of the returned result.

Returns:

• (Integer) —

  the HTTP status code of the returned result.

# File 'lib/harkness/models/base/data_wrapper.rb', line 9

attribute :code, Shale::Type::Integer

#copyright ⇒ String (readonly)

Returns the copyright notice for the returned result.

Returns:

• (String) —

  the copyright notice for the returned result.

# File 'lib/harkness/models/base/data_wrapper.rb', line 15

attribute :copyright, Shale::Type::String

#data ⇒ Harkness::Base::DataContainer (readonly)

Returns the results returned by the call.

Returns:

• (Harkness::Base::DataContainer) —

  the results returned by the call.

# File 'lib/harkness/models/base/data_wrapper.rb', line 28

attribute :data, Harkness::Base::DataContainer

#etag ⇒ String (readonly)

Returns a digest value of the content returned by the call.

Returns:

• (String) —

  a digest value of the content returned by the call.

# File 'lib/harkness/models/base/data_wrapper.rb', line 31

attribute :etag, Shale::Type::String

#status ⇒ String (readonly)

Returns a string description of the call status.

Returns:

• (String) —

  a string description of the call status.

# File 'lib/harkness/models/base/data_wrapper.rb', line 12

attribute :status, Shale::Type::String