Class: LWS::DigitalSignage::Layout

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/digital_signage.rb

Overview

The layout class

Defined Under Namespace

Classes: Category, Element, Version

Instance Attribute Summary collapse

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#dig, #reload, #rollback, #save

Instance Attribute Details

#categories ⇒ Array<Layout::Category>

Returns the categories associated with the layout.

Returns:



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

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:



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

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



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

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



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

attribute :default_duration

#description ⇒ String?

Returns the description of the layout.

Returns:

  • (String, nil) —

    the description of the layout



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

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



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

attribute :favorite

#name ⇒ String

Returns the name of the layout.

Returns:

  • (String) —

    the name of the layout



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

attribute :name

#parent ⇒ Layout?

Returns the parent of the layout.

Returns:

  • (Layout, nil) —

    the parent of the layout



522
523
524
 
# File 'lib/lws/apps/digital_signage.rb', line 522

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



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

attribute :parent_id

#priority ⇒ Boolean

Returns whether the layout has priority over others.

Returns:

  • (Boolean) —

    whether the layout has priority over others



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

attribute :priority

#slides ⇒ Array<Slide>

Returns the slides using the layout.

Returns:

  • (Array<Slide>) —

    the slides using the layout



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

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



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

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



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

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



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

attribute :trans_duration

#versions ⇒ Array<Version>

Returns the versions of the layout.

Returns:

  • (Array<Version>) —

    the versions of the layout



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

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