Class: Harkness::CharacterList

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::CharacterList

Defined in:

lib/harkness/models/character_list.rb

Overview

A list of characters.

Instance Attribute Summary

• #available ⇒ Integer readonly

  The number of total available characters in this list.

• #collectionURI ⇒ String readonly

  The path to the full list of characters in this collection.

• #items ⇒ Array<Harkness::CharacterSummary> readonly

  The list of returned characters in this collection.

• #returned ⇒ Integer readonly

  The number of characters returned in this collection (up to 20).

Instance Attribute Details

#available ⇒ Integer (readonly)

Returns the number of total available characters in this list. Will always be greater than or equal to the "returned" value.

Returns:

• (Integer) —

  the number of total available characters in this list. Will always be greater than or equal to the "returned" value.

# File 'lib/harkness/models/character_list.rb', line 16

attribute :available, Shale::Type::Integer

#collectionURI ⇒ String (readonly)

Returns the path to the full list of characters in this collection.

Returns:

• (String) —

  the path to the full list of characters in this collection.

# File 'lib/harkness/models/character_list.rb', line 22

attribute :collectionURI, Shale::Type::String

#items ⇒ Array<Harkness::CharacterSummary> (readonly)

Returns the list of returned characters in this collection.

Returns:

• (Array<Harkness::CharacterSummary>) —

  the list of returned characters in this collection.

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

attribute :items, Harkness::CharacterSummary, collection: true

#returned ⇒ Integer (readonly)

Returns the number of characters returned in this collection (up to 20).

Returns:

• (Integer) —

  the number of characters returned in this collection (up to 20).

# File 'lib/harkness/models/character_list.rb', line 19

attribute :returned, Shale::Type::Integer