Class: LWS::DigitalSignage::Player::Configuration

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Player::Configuration

Defined in:

lib/lws/apps/digital_signage.rb

Overview

The player configuration class

Defined Under Namespace

Classes: Setting

Instance Attribute Summary

• #company ⇒ LWS::Auth::Company

  The company the player configuration belongs to.

• #company_id ⇒ Integer

  The ID of the company the player configuration belongs to.

• #description ⇒ String^?

  The description of the player configuration.

• #name ⇒ String

  The name of the player configuration.

• #player_ids ⇒ Array<Integer>

  The IDs of the players the configuration is used for.

• #players ⇒ Array<Player>

  The players the configuration is used for.

• #predefined_configuration ⇒ Player::PredefinedConfiguration^?

  The predefined configuration that is used as a bases for the configuration.

• #predefined_configuration_id ⇒ Integer^?

  The ID of the predefined configuration that is used as a basis for the player configuration.

• #setting_ids ⇒ Array<Integer>

  The IDs of the settings of the player configuration.

• #settings ⇒ Array<Player::Configuration::Setting>

  The settings of the player configuration.

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

#company ⇒ LWS::Auth::Company

Returns the company the player configuration belongs to.

Returns:

• (LWS::Auth::Company) —

  the company the player configuration belongs to

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

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

#company_id ⇒ Integer

Returns the ID of the company the player configuration belongs to.

Returns:

• (Integer) —

  the ID of the company the player configuration belongs to

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

attribute :company_id

#description ⇒ String^?

Returns the description of the player configuration.

Returns:

• (String, nil) —

  the description of the player configuration

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

attribute :description

#name ⇒ String

Returns the name of the player configuration.

Returns:

• (String) —

  the name of the player configuration

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

attribute :name

#player_ids ⇒ Array<Integer>

Returns the IDs of the players the configuration is used for.

Returns:

• (Array<Integer>) —

  the IDs of the players the configuration is used for

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

attribute :player_ids

#players ⇒ Array<Player>

Returns the players the configuration is used for.

Returns:

• (Array<Player>) —

  the players the configuration is used for

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

has_many :players, class_name: "LWS::DigitalSignage::Player",
uri: "player/configurations/:configuration_id/players(/:id)"

#predefined_configuration ⇒ Player::PredefinedConfiguration^?

Returns the predefined configuration that is used as a bases for the configuration.

Returns:

• (Player::PredefinedConfiguration, nil) —

  the predefined configuration that is used as a bases for the configuration

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

belongs_to :predefined_configuration, class_name: "LWS::DigitalSignage::Player::PredefinedConfiguration",
uri: "player/predefined_configurations/:id"

#predefined_configuration_id ⇒ Integer^?

Returns the ID of the predefined configuration that is used as a basis for the player configuration.

Returns:

• (Integer, nil) —

  the ID of the predefined configuration that is used as a basis for the player configuration

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

attribute :predefined_configuration_id

#setting_ids ⇒ Array<Integer>

Returns the IDs of the settings of the player configuration.

Returns:

• (Array<Integer>) —

  the IDs of the settings of the player configuration

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

attribute :setting_ids

#settings ⇒ Array<Player::Configuration::Setting>

Returns the settings of the player configuration.

Returns:

• (Array<Player::Configuration::Setting>) —

  the settings of the player configuration

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

has_many :settings, class_name: "LWS::DigitalSignage::Player::Configuration::Setting",
uri: "player/configurations/:configuration_id/settings(/:id)"