Class: LWS::DigitalSignage::Channel

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/digital_signage.rb

Overview

The channel class

Defined Under Namespace

Classes: Group, Tag, TimeSchedule, TimeScheduleOverride

Instance Attribute Summary collapse

Attributes inherited from Generic::Model

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

Method Summary

Methods inherited from Generic::Model

#deep_dup, #dig, #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)



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

attribute :bandwidth

#company ⇒ LWS::Auth::Company

Returns the company the channel belongs to.

Returns:



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

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



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

attribute :company_id

#daily_reboot_time ⇒ String

Returns the daily reboot time of the channel.

Returns:

  • (String) —

    the daily reboot time of the channel



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

attribute :daily_reboot_time

#display ⇒ Object

:nocov:



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

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



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

attribute :display_id

#group_ids ⇒ Array<Integer>

Returns the IDs of the groups the channel is a member of.

Returns:

  • (Array<Integer>) —

    the IDs of the groups the channel is a member of



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

attribute :group_ids

#groups ⇒ Array<Channel::Group>

Returns the groups the channel is a member of.

Returns:



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

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

#layout_kind ⇒ "default", "stage"

Returns the layout (version) kinds to consider when generating a playlist for the channel.

Returns:

  • ("default", "stage") —

    the layout (version) kinds to consider when generating a playlist for the channel



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

attribute :layout_kind

#marquee_config ⇒ String

Returns the marquee/ticker tape configuration (JSON) of the channel.

Returns:

  • (String) —

    the marquee/ticker tape configuration (JSON) of the channel



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

attribute :marquee_config

#name ⇒ String

Returns the name of the channel.

Returns:

  • (String) —

    the name of the channel



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

attribute :name

#orientation ⇒ "normal", ...

Returns the orientation of the channel.

Returns:

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

    the orientation of the channel



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

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



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

attribute :persistent_connection

#player_ids ⇒ Array<Integer>

Returns the IDs of the players linked to the channel.

Returns:

  • (Array<Integer>) —

    the IDs of the players linked to the channel



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

attribute :player_ids

#players ⇒ Array<Player>

Returns the players linked to the channel.

Returns:

  • (Array<Player>) —

    the players linked to the channel



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

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



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

attribute :remote_control

#slide_ids ⇒ Array<Integer>

Returns the IDs of the slides schedules on the channel.

Returns:

  • (Array<Integer>) —

    the IDs of the slides schedules on the channel



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

attribute :slide_ids

#slides ⇒ Array<Slide>

Returns the slides schedules on the channel.

Returns:

  • (Array<Slide>) —

    the slides schedules on the channel



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

has_many :slides, class_name: "LWS::DigitalSignage::Slide"

#tag_ids ⇒ Array<Integer>

Returns the IDs of the tags of the channel.

Returns:

  • (Array<Integer>) —

    the IDs of the tags of the channel



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

attribute :tag_ids

#tags ⇒ Array<Channel::Tag>

Returns the tags of the channel.

Returns:



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

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

#time_schedule ⇒ Channel::TimeSchedule

Returns the time schedule of the channel.

Returns:



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

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



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

attribute :time_schedule_id

#time_schedule_override_ids ⇒ Array<Integer>

Returns the IDs of the time schedule overrides of the channel.

Returns:

  • (Array<Integer>) —

    the IDs of the time schedule overrides of the channel



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

attribute :time_schedule_override_ids

#time_schedule_overrides ⇒ Array<Channel::TimeScheduleOverride>

Returns the time schedule overrides of the channel.

Returns:



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

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



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

attribute :time_zone

#volume ⇒ Integer

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

Returns:

  • (Integer) —

    the audio volume setting of the channel (percentage)



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

attribute :volume