Class: LWS::DigitalSignage::Slide

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Slide

Defined in:

lib/lws/apps/digital_signage.rb

Overview

The slide class

Defined Under Namespace

Classes: Schedule

Instance Attribute Summary

• #account ⇒ LWS::Auth::Account

  The account used for creating the slide.

• #account_id ⇒ Integer

  The ID of the account used for creating the slide.

• #channel_groups ⇒ Array<Channel::Group>

  The channel group the slide is scheduled on.

• #channels ⇒ Array<Channel>

  The channels the slide is scheduled on.

• #comments ⇒ String^?

  The comments/remarks for the slide.

• #company ⇒ LWS::Auth::Company

  The company the slide belongs to.

• #company_id ⇒ Integer

  The ID of the company the slide belongs to.

• #duration ⇒ Integer^?

  The duration of the slide (for fixed or content-bound durations in the layout).

• #edit_account_ids ⇒ Array<Integer>

  The IDs of the accounts that can edit the slide.

• #editable_by_me ⇒ Boolean

  Whether the authenticated user can edit the slide.

• #layout ⇒ LWS::Layout

  The layout the slide uses.

• #layout_id ⇒ Integer

  The ID of the layout the slide uses.

• #name ⇒ String

  The name of the slide.

• #order_priority ⇒ Integer

  The order priority within a playlist for a channel.

• #schedules ⇒ Array<Schedule>

  The slide schedules that apply for the slide.

• #status ⇒ "initializing", ... readonly

  The status of the slide.

• #thumbnail_url ⇒ String^?

  The URL of the thumbnail of the slide.

• #uuid ⇒ String

  The UUID of the slide.

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

#account ⇒ LWS::Auth::Account

Returns the account used for creating the slide.

Returns:

• (LWS::Auth::Account) —

  the account used for creating the slide

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

belongs_to :account, class_name: "LWS::Auth::Account"

#account_id ⇒ Integer

Returns the ID of the account used for creating the slide.

Returns:

• (Integer) —

  the ID of the account used for creating the slide

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

attribute :account_id

#channel_groups ⇒ Array<Channel::Group>

Returns the channel group the slide is scheduled on.

Returns:

• (Array<Channel::Group>) —

  the channel group the slide is scheduled on

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

has_many :channel_groups, class_name: "LWS::DigitalSignage::Channel::Group"

#channels ⇒ Array<Channel>

Returns the channels the slide is scheduled on.

Returns:

• (Array<Channel>) —

  the channels the slide is scheduled on

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

has_many :channels, class_name: "LWS::DigitalSignage::Channel"

#comments ⇒ String^?

Returns the comments/remarks for the slide.

Returns:

• (String, nil) —

  the comments/remarks for the slide

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

attribute :comments

#company ⇒ LWS::Auth::Company

Returns the company the slide belongs to.

Returns:

• (LWS::Auth::Company) —

  the company the slide belongs to

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

belongs_to :company, class_name: "LWS::Auth::Company"

#company_id ⇒ Integer

Returns the ID of the company the slide belongs to.

Returns:

• (Integer) —

  the ID of the company the slide belongs to

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

attribute :company_id

#duration ⇒ Integer^?

Returns the duration of the slide (for fixed or content-bound durations in the layout).

Returns:

• (Integer, nil) —

  the duration of the slide (for fixed or content-bound durations in the layout)

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

attribute :duration

#edit_account_ids ⇒ Array<Integer>

Returns the IDs of the accounts that can edit the slide.

Returns:

• (Array<Integer>) —

  the IDs of the accounts that can edit the slide

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

attribute :edit_account_ids

#editable_by_me ⇒ Boolean

Returns whether the authenticated user can edit the slide.

Returns:

• (Boolean) —

  whether the authenticated user can edit the slide

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

attribute :editable_by_me

#layout ⇒ LWS::Layout

Returns the layout the slide uses.

Returns:

• (LWS::Layout) —

  the layout the slide uses

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

belongs_to :layout

#layout_id ⇒ Integer

Returns the ID of the layout the slide uses.

Returns:

• (Integer) —

  the ID of the layout the slide uses

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

attribute :layout_id

#name ⇒ String

Returns the name of the slide.

Returns:

• (String) —

  the name of the slide

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

attribute :name

#order_priority ⇒ Integer

Returns the order priority within a playlist for a channel.

Returns:

• (Integer) —

  the order priority within a playlist for a channel

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

attribute :order_priority

#schedules ⇒ Array<Schedule>

Returns the slide schedules that apply for the slide.

Returns:

• (Array<Schedule>) —

  the slide schedules that apply for the slide

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

has_many :schedules, class_name: "LWS::DigitalSignage::Slide::Schedule"

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

Returns the status of the slide.

Returns:

• ("initializing", "waiting_content", "available", "error") —

  the status of the slide

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

attribute :status

#thumbnail_url ⇒ String^?

Returns the URL of the thumbnail of the slide.

Returns:

• (String, nil) —

  the URL of the thumbnail of the slide

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

attribute :thumbnail_url

#uuid ⇒ String

Returns the UUID of the slide.

Returns:

• (String) —

  the UUID of the slide

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

attribute :uuid