Class: LWS::DigitalSignage::Layout

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Layout

Defined in:

lib/lws/apps/digital_signage.rb

Overview

The layout class

Defined Under Namespace

Classes: Category, Element, Version

Instance Attribute Summary

• #categories ⇒ Array<Layout::Category>

  The categories associated with the layout.

• #company ⇒ LWS::Auth::Company

  The company the layout belongs to.

• #company_id ⇒ Integer

  The ID of the company the layout belongs to.

• #default_duration ⇒ 5..3600

  The default duration of a slide created from the layout.

• #description ⇒ String^?

  The description of the layout.

• #favorite ⇒ Boolean

  Whether the layout is a favorite for the current account.

• #kind ⇒ "marquee", "slide"

  The kind of the layout.

• #name ⇒ String

  The name of the layout.

• #parent ⇒ Layout^?

  The parent of the layout.

• #parent_id ⇒ Integer^?

  The ID of the parent of the layout.

• #priority ⇒ Boolean

  Whether the layout has priority over others.

• #slides ⇒ Array<Slide>

  The slides using the layout.

• #trans ⇒ "cut", ...

  The transition of the entire layout.

• #trans_direction ⇒ "left", ...

  The direction of the transition of the entire layout.

• #trans_duration ⇒ Integer

  The duration of the transition of the entire layout.

• #versions ⇒ Array<Version>

  The versions of the layout.

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

#categories ⇒ Array<Layout::Category>

Returns the categories associated with the layout.

Returns:

• (Array<Layout::Category>) —

  the categories associated with the layout

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

has_many :categories, class_name: "LWS::DigitalSignage::Layout::Category",
uri: "layout/:layout_id/categories(/:id)"

#company ⇒ LWS::Auth::Company

Returns the company the layout belongs to.

Returns:

• (LWS::Auth::Company) —

  the company the layout belongs to

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

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

#company_id ⇒ Integer

Returns the ID of the company the layout belongs to.

Returns:

• (Integer) —

  the ID of the company the layout belongs to

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

attribute :company_id

#default_duration ⇒ 5..3600

Returns the default duration of a slide created from the layout.

Returns:

• (5..3600) —

  the default duration of a slide created from the layout

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

attribute :default_duration

#description ⇒ String^?

Returns the description of the layout.

Returns:

• (String, nil) —

  the description of the layout

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

attribute :description

#favorite ⇒ Boolean

Returns whether the layout is a favorite for the current account.

Returns:

• (Boolean) —

  whether the layout is a favorite for the current account

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

attribute :favorite

#kind ⇒ "marquee", "slide"

Returns the kind of the layout.

Returns:

• ("marquee", "slide") —

  the kind of the layout

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

attribute :kind

#name ⇒ String

Returns the name of the layout.

Returns:

• (String) —

  the name of the layout

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

attribute :name

#parent ⇒ Layout^?

Returns the parent of the layout.

Returns:

• (Layout, nil) —

  the parent of the layout

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

belongs_to :parent, class_name: "LWS::DigitalSignage::Layout",
foreign_key: :parent_id,
uri: "layouts/:id"

#parent_id ⇒ Integer^?

Returns the ID of the parent of the layout.

Returns:

• (Integer, nil) —

  the ID of the parent of the layout

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

attribute :parent_id

#priority ⇒ Boolean

Returns whether the layout has priority over others.

Returns:

• (Boolean) —

  whether the layout has priority over others

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

attribute :priority

#slides ⇒ Array<Slide>

Returns the slides using the layout.

Returns:

• (Array<Slide>) —

  the slides using the layout

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

has_many :slides, class_name: "LWS::DigitalSignage::Slide",
uri: "layouts/:layout_id/slides(/:id)"

#trans ⇒ "cut", ...

Returns the transition of the entire layout.

Returns:

• ("cut", "fadein", "zoomin", "slidein") —

  the transition of the entire layout

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

attribute :trans

#trans_direction ⇒ "left", ...

Returns the direction of the transition of the entire layout.

Returns:

• ("left", "right", "up", "down") —

  the direction of the transition of the entire layout

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

attribute :trans_direction

#trans_duration ⇒ Integer

Returns the duration of the transition of the entire layout.

Returns:

• (Integer) —

  the duration of the transition of the entire layout

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

attribute :trans_duration

#versions ⇒ Array<Version>

Returns the versions of the layout.

Returns:

• (Array<Version>) —

  the versions of the layout

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

has_many :versions, class_name: "LWS::DigitalSignage::Layout::Version",
uri: "layouts/:layout_id/versions(/:id)"