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

#deep_dup, #dig, #reload, #rollback, #save

Instance Attribute Details

#categories ⇒ Array<Layout::Category>

Returns the categories associated with the layout.

Returns:



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

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

#category_ids ⇒ Array<Integer>

Returns the IDs of the categories assoicated with the layout.

Returns:

  • (Array<Integer>) —

    the IDs of the categories assoicated with the layout



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

attribute :category_ids

#company_owner ⇒ LWS::Auth::Company

Returns the company that owns the layout.

Returns:



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

belongs_to :company_owner, class_name: "LWS::Auth::Company",
foreign_key: :company_owner_id,
uri: "companies/:id"

#company_owner_id ⇒ Integer

Returns the ID of the company that owns the layout.

Returns:

  • (Integer) —

    the ID of the company that owns the layout



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

attribute :company_owner_id

#company_shared_ids ⇒ Array<Integer>

Returns the IDs of the company the layout is shared with.

Returns:

  • (Array<Integer>) —

    the IDs of the company the layout is shared with



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

attribute :company_shared_ids

#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



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

attribute :default_duration

#description ⇒ String?

Returns the description of the layout.

Returns:

  • (String, nil) —

    the description of the layout



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

attribute :description

#description_html ⇒ String?

Returns an HTML version of the description of the layout.

Returns:

  • (String, nil) —

    an HTML version of the description of the layout



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

attribute :description_html

#duration_kind ⇒ "variable", ...

Returns the duration kind of the layout.

Returns:

  • ("variable", "fixed", "kind") —

    the duration kind of the layout



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

attribute :duration_kind

#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



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

attribute :favorite

#kind ⇒ "marquee", "slide"

Returns the kind of the layout.

Returns:

  • ("marquee", "slide") —

    the kind of the layout



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

attribute :kind

#name ⇒ String

Returns the name of the layout.

Returns:

  • (String) —

    the name of the layout



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

attribute :name

#parent ⇒ Layout?

Returns the parent of the layout.

Returns:

  • (Layout, nil) —

    the parent of the layout



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

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



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

attribute :parent_id

#priority ⇒ Boolean

Returns whether the layout has priority over others.

Returns:

  • (Boolean) —

    whether the layout has priority over others



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

attribute :priority

#public ⇒ Boolean

Returns whether the layout is public (i.e. shared with all companies).

Returns:

  • (Boolean) —

    whether the layout is public (i.e. shared with all companies)



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

attribute :public

#rotation ⇒ "landscape", "portrait"

Returns the rotation (orientation) of the layout.

Returns:

  • ("landscape", "portrait") —

    the rotation (orientation) of the layout



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

attribute :rotation

#slides ⇒ Array<Slide>

Returns the slides using the layout.

Returns:

  • (Array<Slide>) —

    the slides using the layout



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

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

#thumbnail_url ⇒ String?

Returns the URL of the thumbnail of the layout.

Returns:

  • (String, nil) —

    the URL of the thumbnail of the layout



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

attribute :thumbnail_url

#trans ⇒ "cut", ...

Returns the transition of the entire layout.

Returns:

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

    the transition of the entire layout



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

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



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

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



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

attribute :trans_duration

#versions ⇒ Array<Version>

Returns the versions of the layout.

Returns:

  • (Array<Version>) —

    the versions of the layout



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

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