Class: BBC::Redux::Channel

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

Overview

Redux API Channel Object

Examples:

Properties of the channel object


channel = redux_client.channels.first

channel.category_id  #=> Integer
channel.display_name #=> String
channel.name         #=> String
channel.sort_order   #=> Integer

Author:

Instance Attribute Summary collapse

Instance Attribute Details

#category_idInteger (readonly)

Returns channel's category id.

Returns:

  • (Integer)

    channel's category id


24
# File 'lib/bbc/redux/channel.rb', line 24

attribute :category_id, Integer

#display_nameString (readonly) Also known as: longname

Returns channel display name, e.g. 'BBC One'.

Returns:

  • (String)

    channel display name, e.g. 'BBC One'


28
# File 'lib/bbc/redux/channel.rb', line 28

attribute :display_name, String

#nameString (readonly)

Returns channel short name, e.g. 'bbcone'.

Returns:

  • (String)

    channel short name, e.g. 'bbcone'


34
# File 'lib/bbc/redux/channel.rb', line 34

attribute :name, String

#sortorderInteger (readonly) Also known as: sort_order

Returns channel's suggested sort order in list views.

Returns:

  • (Integer)

    channel's suggested sort order in list views


38
# File 'lib/bbc/redux/channel.rb', line 38

attribute :sortorder, Integer