Class: LWS::DigitalSignage::Player::PredefinedConfiguration::Setting

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Player::PredefinedConfiguration::Setting

Defined in:

lib/lws/apps/digital_signage.rb

Overview

Note:

This class is only used within the context of the LWS::DigitalSignage::Player::PredefinedConfiguration class.

The predefined player configuration setting class

Instance Attribute Summary

• #created_at ⇒ String readonly

  The timestamp of when the predefined player configuration setting was created.

• #id ⇒ Fixnum readonly

  The (unique) ID of the predefined player configuration setting.

• #key ⇒ String

  The key of the predefined player configuration setting.

• #predefined_configuration ⇒ Player::PredefinedConfiguration

  The predefined player configuration the setting is defined in.

• #predefined_configuration_id ⇒ Fixnum

  The ID of the predefined player configuration the setting is defined in.

• #protected_value ⇒ Boolean

  Whether the value of the predefined player configuration setting should return a protected representation of the value.

• #updated_at ⇒ String readonly

  The timestamp of when the predefined player configuration setting was last updated.

• #value ⇒ String^?

  The value of the predefined player configuration setting.

Instance Attribute Details

#created_at ⇒ String (readonly)

Returns the timestamp of when the predefined player configuration setting was created.

Returns:

• (String) —

  the timestamp of when the predefined player configuration setting was created

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

attribute :created_at

#id ⇒ Fixnum (readonly)

Returns the (unique) ID of the predefined player configuration setting.

Returns:

• (Fixnum) —

  the (unique) ID of the predefined player configuration setting

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

attribute :id

#key ⇒ String

Returns the key of the predefined player configuration setting.

Returns:

• (String) —

  the key of the predefined player configuration setting

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

attribute :key

#predefined_configuration ⇒ Player::PredefinedConfiguration

Returns the predefined player configuration the setting is defined in.

Returns:

• (Player::PredefinedConfiguration) —

  the predefined player configuration the setting is defined in

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

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 player configuration the setting is defined in.

Returns:

• (Fixnum) —

  the ID of the predefined player configuration the setting is defined in

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

attribute :predefined_configuration_id

#protected_value ⇒ Boolean

Returns whether the value of the predefined player configuration setting should return a protected representation of the value.

Returns:

• (Boolean) —

  whether the value of the predefined player configuration setting should return a protected representation of the value

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

attribute :protected_value

#updated_at ⇒ String (readonly)

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

Returns:

• (String) —

  the timestamp of when the predefined player configuration setting was last updated

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

attribute :updated_at

#value ⇒ String^?

Returns the value of the predefined player configuration setting.

Returns:

• (String, nil) —

  the value of the predefined player configuration setting

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

attribute :value