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:



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

has_many :categories, class_name: "LWS::DigitalSignage::Layout::Category",
uri: "layouts/: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



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

attribute :category_ids

#company_owner ⇒ LWS::Auth::Company

Returns the company that owns the layout.

Returns:



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

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



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

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



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

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



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

attribute :default_duration

#description ⇒ String?

Returns the description of the layout.

Returns:

  • (String, nil) —

    the description of the layout



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

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



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

attribute :description_html

#duration_kind ⇒ "variable", ...

Returns the duration kind of the layout.

Returns:

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

    the duration kind of the layout



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

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



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

attribute :favorite

#kind ⇒ "marquee", "slide"

Returns the kind of the layout.

Returns:

  • ("marquee", "slide") —

    the kind of the layout



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

attribute :kind

#name ⇒ String

Returns the name of the layout.

Returns:

  • (String) —

    the name of the layout



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

attribute :name

#parent ⇒ Layout?

Returns the parent of the layout.

Returns:

  • (Layout, nil) —

    the parent of the layout



644
645
646
 
# File 'lib/lws/apps/digital_signage.rb', line 644

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



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

attribute :parent_id

#priority ⇒ Boolean

Returns whether the layout has priority over others.

Returns:

  • (Boolean) —

    whether the layout has priority over others



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

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)



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

attribute :public

#rotation ⇒ "landscape", "portrait"

Returns the rotation (orientation) of the layout.

Returns:

  • ("landscape", "portrait") —

    the rotation (orientation) of the layout



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

attribute :rotation

#slide_ids ⇒ Array<Integer>

Returns the IDs of the slides using the layout.

Returns:

  • (Array<Integer>) —

    the IDs of the slides using the layout



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

attribute :slide_ids

#slides ⇒ Array<Slide>

Returns the slides using the layout.

Returns:

  • (Array<Slide>) —

    the slides using the layout



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

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



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

attribute :thumbnail_url

#trans ⇒ "cut", ...

Returns the transition of the entire layout.

Returns:

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

    the transition of the entire layout



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

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



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

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



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

attribute :trans_duration

#version_ids ⇒ Array<Integer>

Returns the IDs of the versions of the layout.

Returns:

  • (Array<Integer>) —

    the IDs of the versions of the layout



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

attribute :version_ids

#versions ⇒ Array<Version>

Returns the versions of the layout.

Returns:

  • (Array<Version>) —

    the versions of the layout



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

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