Class: LWS::DigitalSignage::Layout::Version

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

Overview

Note:

This class is only used within the context of the LWS::DigitalSignage::Layout class.

The layout version class

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

#archive_storage_id ⇒ String?

Returns sthe storage ID of the archive/layout pack of the layout version.

Returns:

  • (String, nil) —

    sthe storage ID of the archive/layout pack of the layout version



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

attribute :archive_storage_id

#archive_url ⇒ String?

Note:

To be able retrieve the archive, the token needs to be passed via X-Token in the HTTP request headers!

Note:

This attribute is only available if the token is of an account with sysadmin permissions

Returns the URL of the archive/layout pack of the layout version (if accessible).

Returns:

  • (String, nil) —

    the URL of the archive/layout pack of the layout version (if accessible)



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

attribute :archive_url

#elements ⇒ Array<Layout::Element>

Returns the elements contained in the layout version.

Returns:

  • (Array<Layout::Element>) —

    the elements contained in the layout version



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

has_many :elements, class_name: "LWS::DigitalSignage::Layout::Element"

#height ⇒ Integer

Returns the intended height of the layout version.

Returns:

  • (Integer) —

    the intended height of the layout version



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

attribute :width

#layout ⇒ Layout

Returns the layout the layout version is for.

Returns:

  • (Layout) —

    the layout the layout version is for



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

belongs_to :layout

#layout_id ⇒ Integer

Returns the ID of the layout the layout version is for.

Returns:

  • (Integer) —

    the ID of the layout the layout version is for



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

attribute :layout_id

#rotation ⇒ "landscape", "portrait"

Returns the rotation (orientation) of the layout version.

Returns:

  • ("landscape", "portrait") —

    the rotation (orientation) of the layout version



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

attribute :rotation

#rotation_angle ⇒ 0, 90

Returns the rotation angle of the layout version.

Returns:

  • (0, 90) —

    the rotation angle of the layout version



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

attribute :rotation_angle

#status ⇒ "initializing", ... (readonly)

Returns the status of the layout version.

Returns:

  • ("initializing", "creating_pack", "creating_thumbnail", "available", "archive", "stage") —

    the status of the layout version



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

attribute :status

#thumbnail_url ⇒ String?

Returns the URL of the thumbnail of the layout version.

Returns:

  • (String, nil) —

    the URL of the thumbnail of the layout version



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

attribute :thumbnail_url

#width ⇒ Integer

Returns the intended width of the layout version.

Returns:

  • (Integer) —

    the intended width of the layout version



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

attribute :width