Class: LWS::DigitalSignage::Player::Component

Inherits:

Generic::Model

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

Defined in:

lib/lws/apps/digital_signage.rb

Overview

The player component class

Defined Under Namespace

Classes: Part

Instance Attribute Summary

• #created_at ⇒ String readonly

  The timestamp of when the player component was created.

• #description ⇒ String^?

  The description of the player component.

• #id ⇒ Fixnum readonly

  The (unique) ID of the player component.

• #models ⇒ Array<Player::Model>

  The player models that use the component.

• #name ⇒ String

  The name of the player component.

• #parts ⇒ Array<Player::Component::Part>

  The parts the component is made out of.

• #slug ⇒ String readonly

  The slug(ified name) of the player component.

• #supplier ⇒ LWS::Auth::Company

  The supplier of the component part.

• #supplier_id ⇒ Fixnum

  The ID of the supplier of the component part.

• #updated_at ⇒ String readonly

  The timestamp of when the player component was last updated.

Instance Attribute Details

#created_at ⇒ String (readonly)

Returns the timestamp of when the player component was created.

Returns:

• (String) —

  the timestamp of when the player component was created

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

attribute :created_at

#description ⇒ String^?

Returns the description of the player component.

Returns:

• (String, nil) —

  the description of the player component

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

attribute :description

#id ⇒ Fixnum (readonly)

Returns the (unique) ID of the player component.

Returns:

• (Fixnum) —

  the (unique) ID of the player component

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

attribute :id

#models ⇒ Array<Player::Model>

Returns the player models that use the component.

Returns:

• (Array<Player::Model>) —

  the player models that use the component

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

has_many :models, class_name: "LWS::DigitalSignage::Player::Model",
uri: "player/components/:component_id/models"

#name ⇒ String

Returns the name of the player component.

Returns:

• (String) —

  the name of the player component

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

attribute :name

#parts ⇒ Array<Player::Component::Part>

Returns the parts the component is made out of.

Returns:

• (Array<Player::Component::Part>) —

  the parts the component is made out of

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

has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part",
uri: "player/components/:component_id/parts"

#slug ⇒ String (readonly)

Returns the slug(ified name) of the player component.

Returns:

• (String) —

  the slug(ified name) of the player component

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

attribute :slug

#supplier ⇒ LWS::Auth::Company

Returns the supplier of the component part.

Returns:

• (LWS::Auth::Company) —

  the supplier of the component part

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

belongs_to :supplier, class_name: "LWS::Auth::Company",
foreign_key: "supplier_id",
uri: "companies/:id"

#supplier_id ⇒ Fixnum

Returns the ID of the supplier of the component part.

Returns:

• (Fixnum) —

  the ID of the supplier of the component part

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

attribute :supplier_id

#updated_at ⇒ String (readonly)

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

Returns:

• (String) —

  the timestamp of when the player component was last updated

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

attribute :updated_at