Class: LWS::DigitalSignage::Channel

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Channel

Defined in:

lib/lws/apps/digital_signage.rb

Overview

The channel class

Defined Under Namespace

Classes: Group, Tag, TimeSchedule, TimeScheduleOverride

Instance Attribute Summary

• #bandwidth ⇒ Integer

  The bandwidth limit for the channel (bytes per second).

• #company ⇒ LWS::Auth::Company

  The company the channel belongs to.

• #company_id ⇒ Integer

  The ID of the company the channel belongs to.

• #daily_reboot_time ⇒ String

  The daily reboot time of the channel.

• #display ⇒ Object

  :nocov:.

• #display_id ⇒ Integer

  The ID of the display of the channel.

• #groups ⇒ Array<Channel::Group>

  The groups the channel is a member of.

• #name ⇒ String

  The name of the channel.

• #orientation ⇒ "normal", ...

  The orientation of the channel.

• #persistent_connection ⇒ Boolean

  Whether the channel is considered to have a persistent network connection.

• #players ⇒ Array<Player>

  The players linked to the channel.

• #remote_control ⇒ Boolean

  Whether remote control is enabled for the channel.

• #tags ⇒ Array<Channel::Tag>

  The tags of the channel.

• #time_schedule ⇒ Channel::TimeSchedule

  The time schedule of the channel.

• #time_schedule_id ⇒ Integer

  The ID of the time schedule of the channel.

• #time_schedule_overrides ⇒ Array<Channel::TimeScheduleOverride>

  The time schedule overrides of the channel.

• #time_zone ⇒ String

  The time zone for the channel.

• #volume ⇒ Integer

  The audio volume setting of the channel (percentage).

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#reload, #rollback, #save

Instance Attribute Details

#bandwidth ⇒ Integer

Returns the bandwidth limit for the channel (bytes per second).

Returns:

• (Integer) —

  the bandwidth limit for the channel (bytes per second)

# File 'lib/lws/apps/digital_signage.rb', line 44

attribute :bandwidth

#company ⇒ LWS::Auth::Company

Returns the company the channel belongs to.

Returns:

• (LWS::Auth::Company) —

  the company the channel belongs to

# File 'lib/lws/apps/digital_signage.rb', line 48

belongs_to :company, class_name: "LWS::Auth::Company"

#company_id ⇒ Integer

Returns the ID of the company the channel belongs to.

Returns:

• (Integer) —

  the ID of the company the channel belongs to

# File 'lib/lws/apps/digital_signage.rb', line 52

attribute :company_id

#daily_reboot_time ⇒ String

Returns the daily reboot time of the channel.

Returns:

• (String) —

  the daily reboot time of the channel

# File 'lib/lws/apps/digital_signage.rb', line 56

attribute :daily_reboot_time

#display ⇒ Object

:nocov:

# File 'lib/lws/apps/digital_signage.rb', line 60

belongs_to :display, class_name: "LWS::DigitalSignage::Display"

#display_id ⇒ Integer

Returns the ID of the display of the channel.

Returns:

• (Integer) —

  the ID of the display of the channel

# File 'lib/lws/apps/digital_signage.rb', line 70

attribute :display_id

#groups ⇒ Array<Channel::Group>

Returns the groups the channel is a member of.

Returns:

• (Array<Channel::Group>) —

  the groups the channel is a member of

# File 'lib/lws/apps/digital_signage.rb', line 74

has_many :groups, class_name: "LWS::DigitalSignage::Channel::Group"

#name ⇒ String

Returns the name of the channel.

Returns:

• (String) —

  the name of the channel

# File 'lib/lws/apps/digital_signage.rb', line 78

attribute :name

#orientation ⇒ "normal", ...

Returns the orientation of the channel.

Returns:

• ("normal", "left", "right", "inverted") —

  the orientation of the channel

# File 'lib/lws/apps/digital_signage.rb', line 83

attribute :orientation

#persistent_connection ⇒ Boolean

Returns whether the channel is considered to have a persistent network connection.

Returns:

• (Boolean) —

  whether the channel is considered to have a persistent network connection

# File 'lib/lws/apps/digital_signage.rb', line 88

attribute :persistent_connection

#players ⇒ Array<Player>

Returns the players linked to the channel.

Returns:

• (Array<Player>) —

  the players linked to the channel

# File 'lib/lws/apps/digital_signage.rb', line 92

has_many :players, class_name: "LWS::DigitalSignage::Player"

#remote_control ⇒ Boolean

Returns whether remote control is enabled for the channel.

Returns:

• (Boolean) —

  whether remote control is enabled for the channel

# File 'lib/lws/apps/digital_signage.rb', line 96

attribute :remote_control

#tags ⇒ Array<Channel::Tag>

Returns the tags of the channel.

Returns:

• (Array<Channel::Tag>) —

  the tags of the channel

# File 'lib/lws/apps/digital_signage.rb', line 100

has_many :tags, class_name: "LWS::DigitalSignage::Channel::Tag"

#time_schedule ⇒ Channel::TimeSchedule

Returns the time schedule of the channel.

Returns:

• (Channel::TimeSchedule) —

  the time schedule of the channel

# File 'lib/lws/apps/digital_signage.rb', line 104

belongs_to :time_schedule, class_name: "LWS::DigitalSignage::Channel::TimeSchedule",
uri: "channel/time_schedules/:id"

#time_schedule_id ⇒ Integer

Returns the ID of the time schedule of the channel.

Returns:

• (Integer) —

  the ID of the time schedule of the channel

# File 'lib/lws/apps/digital_signage.rb', line 109

attribute :time_schedule_id

#time_schedule_overrides ⇒ Array<Channel::TimeScheduleOverride>

Returns the time schedule overrides of the channel.

Returns:

• (Array<Channel::TimeScheduleOverride>) —

  the time schedule overrides of the channel

# File 'lib/lws/apps/digital_signage.rb', line 114

has_many :time_schedule_overrides, class_name: "LWS::DigitalSignage::Channel::TimeScheduleOverride"

#time_zone ⇒ String

Returns the time zone for the channel.

Returns:

• (String) —

  the time zone for the channel

# File 'lib/lws/apps/digital_signage.rb', line 118

attribute :time_zone

#volume ⇒ Integer

Returns the audio volume setting of the channel (percentage).

Returns:

• (Integer) —

  the audio volume setting of the channel (percentage)

# File 'lib/lws/apps/digital_signage.rb', line 122

attribute :volume