Class: BBC::Redux::ChannelCategory

Inherits:
Object
  • Object
show all
Defined in:
lib/bbc/redux/channel_category.rb

Overview

Redux API Channel Category Object

Examples:

Properties of the channel category object


category = redux_client.channel_categories.first

category.description  #=> String
category.id           #=> Integer
category.priority     #=> Integer

Author:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString (readonly)

Returns category's description, e.g. 'BBC TV'

Returns:

  • (String)

    category's description, e.g. 'BBC TV'


23
# File 'lib/bbc/redux/channel_category.rb', line 23

attribute :description, String

#idInteger (readonly)

Returns category's id

Returns:

  • (Integer)

    category's id


27
# File 'lib/bbc/redux/channel_category.rb', line 27

attribute :id, Integer

#priorityString (readonly)

Returns category's priority, a hint for display in views

Returns:

  • (String)

    category's priority, a hint for display in views


31
# File 'lib/bbc/redux/channel_category.rb', line 31

attribute :priority, Integer