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.

• #category_ids ⇒ Array<Integer>

  The IDs of the categories assoicated with the layout.

• #company_owner ⇒ LWS::Auth::Company

  The company that owns the layout.

• #company_owner_id ⇒ Integer

  The ID of the company that owns the layout.

• #company_shared_ids ⇒ Array<Integer>

  The IDs of the company the layout is shared with.

• #default_duration ⇒ 5..3600

  The default duration of a slide created from the layout.

• #description ⇒ String^?

  The description of the layout.

• #description_html ⇒ String^?

  An HTML version of the description of the layout.

• #duration_kind ⇒ "variable", ...

  The duration kind 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.

• #public ⇒ Boolean

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

• #rotation ⇒ "landscape", "portrait"

  The rotation (orientation) of the layout.

• #slides ⇒ Array<Slide>

  The slides using the layout.

• #thumbnail_url ⇒ String^?

  The URL of the thumbnail of 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 509

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

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

attribute :category_ids

#company_owner ⇒ LWS::Auth::Company

Returns the company that owns the layout.

Returns:

• (LWS::Auth::Company) —

  the company that owns the layout

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

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

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

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

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

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

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

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 532

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

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

attribute :description_html

#duration_kind ⇒ "variable", ...

Returns the duration kind of the layout.

Returns:

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

  the duration kind of the layout

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

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

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

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 548

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 552

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 557

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 563

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 567

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)

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

attribute :public

#rotation ⇒ "landscape", "portrait"

Returns the rotation (orientation) of the layout.

Returns:

• ("landscape", "portrait") —

  the rotation (orientation) of the layout

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

attribute :rotation

#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 581

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

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

attribute :thumbnail_url

#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 591

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 596

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 600

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 604

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