Class: BBC::Redux::ChannelCategory

Inherits:

Object

• Object
• BBC::Redux::ChannelCategory

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:

• Matt Haynes <matt.haynes@bbc.co.uk>

Instance Attribute Summary

• #description ⇒ String readonly

  Category’s description, e.g.

• #id ⇒ Integer readonly

  Category’s id.

• #priority ⇒ String readonly

  Category’s priority, a hint for display in views.

Instance Attribute Details

#description ⇒ String (readonly)

Returns category’s description, e.g. ‘BBC TV’.

Returns:

• (String) —

  category’s description, e.g. ‘BBC TV’

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

attribute :description, String

#id ⇒ Integer (readonly)

Returns category’s id.

Returns:

• (Integer) —

  category’s id

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

attribute :id, Integer

#priority ⇒ String (readonly)

Returns category’s priority, a hint for display in views.

Returns:

• (String) —

  category’s priority, a hint for display in views

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

attribute :priority, Integer