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 ⇒ Fixnum

  The ID of the company the player configuration belongs to.

• #created_at ⇒ String readonly

  The timestamp of when the player configuration was created.

• #description ⇒ String^?

  The description of the player configuration.

• #id ⇒ Fixnum readonly

  The (unique) ID of the player configuration.

• #name ⇒ String

  The name of the player configuration.

• #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 ⇒ Fixnum^?

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

• #settings ⇒ Player::Configuration::Setting

  The settings of the player configuration.

• #updated_at ⇒ String readonly

  The timestamp of when the player configuration was last updated.

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 801

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

#company_id ⇒ Fixnum

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

Returns:

• (Fixnum) —

  the ID of the company the player configuration belongs to

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

attribute :company_id

#created_at ⇒ String (readonly)

Returns the timestamp of when the player configuration was created.

Returns:

• (String) —

  the timestamp of when the player configuration was created

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

attribute :created_at

#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 809

attribute :description

#id ⇒ Fixnum (readonly)

Returns the (unique) ID of the player configuration.

Returns:

• (Fixnum) —

  the (unique) ID of the player configuration

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

attribute :id

#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 813

attribute :name

#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 817

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 823

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

#predefined_configuration_id ⇒ Fixnum^?

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

Returns:

• (Fixnum, 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 829

attribute :predefined_configuration_id

#settings ⇒ Player::Configuration::Setting

Returns the settings of the player configuration.

Returns:

• (Player::Configuration::Setting) —

  the settings of the player configuration

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

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

#updated_at ⇒ String (readonly)

Returns the timestamp of when the player configuration was last updated.

Returns:

• (String) —

  the timestamp of when the player configuration was last updated

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

attribute :updated_at