Class: Harkness::Story

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::Story

Defined in:

lib/harkness/models/story.rb

Overview

An individual story

Instance Attribute Summary

• #characters ⇒ Harkness::CharacterList readonly

  A resource list of characters which appear in this story.

• #comics ⇒ Harkness::ComicList readonly

  A resource list containing comics in which this story takes place.

• #description ⇒ String readonly

  A description of the story.

• #events ⇒ Harkness::EventList readonly

  A resource list of the events in which this story appears.

• #id ⇒ Integer readonly

  The unique ID of the story resource.

• #modified ⇒ String readonly

  The date the resource was most recently modified.

• #originalIssue ⇒ Harkness::ComicSummary readonly

  A summary representation of the issue in which this story was originally published.

• #resourceURI ⇒ String readonly

  The canonical URL identifier for this resource.

• #series ⇒ Harkness::SeriesList readonly

  A resource list containing series in which this story appears.

• #thumbnail ⇒ String readonly

  The representative image for this story.

• #title ⇒ String readonly

  The canonical title of the story.

• #type ⇒ String readonly

  ' the story type e.g.

Instance Attribute Details

#characters ⇒ Harkness::CharacterList (readonly)

Returns a resource list of characters which appear in this story.

Returns:

• (Harkness::CharacterList) —

  a resource list of characters which appear in this story.

# File 'lib/harkness/models/story.rb', line 38

attribute :characters, Harkness::CharacterList

#comics ⇒ Harkness::ComicList (readonly)

Returns a resource list containing comics in which this story takes place.

Returns:

• (Harkness::ComicList) —

  a resource list containing comics in which this story takes place.

# File 'lib/harkness/models/story.rb', line 29

attribute :comics, Harkness::ComicList

#description ⇒ String (readonly)

Returns a description of the story.

Returns:

• (String) —

  a description of the story.

# File 'lib/harkness/models/story.rb', line 14

attribute :description, Shale::Type::String

#events ⇒ Harkness::EventList (readonly)

Returns a resource list of the events in which this story appears.

Returns:

• (Harkness::EventList) —

  a resource list of the events in which this story appears.

# File 'lib/harkness/models/story.rb', line 35

attribute :events, Harkness::EventList

#id ⇒ Integer (readonly)

Returns the unique ID of the story resource.

Returns:

• (Integer) —

  the unique ID of the story resource.

# File 'lib/harkness/models/story.rb', line 8

attribute :id, Shale::Type::Integer

#modified ⇒ String (readonly)

Returns the date the resource was most recently modified.

Returns:

• (String) —

  the date the resource was most recently modified.

# File 'lib/harkness/models/story.rb', line 23

attribute :modified, Shale::Type::String

#originalIssue ⇒ Harkness::ComicSummary (readonly)

Returns a summary representation of the issue in which this story was originally published.

Returns:

• (Harkness::ComicSummary) —

  a summary representation of the issue in which this story was originally published.

# File 'lib/harkness/models/story.rb', line 42

attribute :originalIssue, Harkness::ComicSummary

#resourceURI ⇒ String (readonly)

Returns the canonical URL identifier for this resource.

Returns:

• (String) —

  the canonical URL identifier for this resource.

# File 'lib/harkness/models/story.rb', line 17

attribute :resourceURI, Shale::Type::String

#series ⇒ Harkness::SeriesList (readonly)

Returns a resource list containing series in which this story appears.

Returns:

• (Harkness::SeriesList) —

  a resource list containing series in which this story appears.

# File 'lib/harkness/models/story.rb', line 32

attribute :series, Harkness::SeriesList

#thumbnail ⇒ String (readonly)

Returns the representative image for this story.

Returns:

• (String) —

  the representative image for this story.

# File 'lib/harkness/models/story.rb', line 26

attribute :thumbnail, Harkness::Image

#title ⇒ String (readonly)

Returns the canonical title of the story.

Returns:

• (String) —

  the canonical title of the story.

# File 'lib/harkness/models/story.rb', line 11

attribute :title, Shale::Type::String

#type ⇒ String (readonly)

Returns ' the story type e.g. interior story, cover, text story.

Returns:

• (String) —

  ' the story type e.g. interior story, cover, text story.

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

attribute :type, Shale::Type::String