Class: BBC::Redux::Channel

Inherits:

Object

• Object
• BBC::Redux::Channel

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:

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

Instance Attribute Summary

• #category_id ⇒ Integer readonly

  Channel’s category id.

• #display_name ⇒ String (also: #longname) readonly

  Channel display name, e.g.

• #name ⇒ String (also: #to_s) readonly

  Channel short name, e.g.

• #sortorder ⇒ Integer (also: #sort_order) readonly

  Channel’s suggested sort order in list views.

Instance Attribute Details

#category_id ⇒ Integer (readonly)

Returns channel’s category id.

Returns:

• (Integer) —

  channel’s category id

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

attribute :category_id, Integer

#display_name ⇒ String (readonly) Also known as: longname

Returns channel display name, e.g. ‘BBC One’.

Returns:

• (String) —

  channel display name, e.g. ‘BBC One’

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

attribute :display_name, String

#name ⇒ String (readonly) Also known as: to_s

Returns channel short name, e.g. ‘bbcone’.

Returns:

• (String) —

  channel short name, e.g. ‘bbcone’

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

attribute :name, String

#sortorder ⇒ Integer (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

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

attribute :sortorder, Integer