Class: LWS::DigitalSignage::Player::Request

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::DigitalSignage::Player::Request

Defined in:

lib/lws/apps/digital_signage.rb

Overview

Note:

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

The player request class

Instance Attribute Summary

• #action ⇒ "unknown", ...

  The player request action.

• #argument ⇒ String^?

  The optional argument for the player request.

• #feedback ⇒ Player::Feedback^?

  This field should be set once the action has been processed (see #processed) and the action is “send_feedback”.

• #feedback_id ⇒ Integer^?

  The ID of the player feedback as a response to the action request “send_status”.

• #log ⇒ Player::Log^?

  This field should be set once the action has been processed (see #processed) and the action is “send_logs”.

• #log_id ⇒ Integer^?

  The ID of the player log as a response to the action request “send_logs”.

• #player ⇒ Player

  The player the request is sent to.

• #player_id ⇒ Integer

  The ID of the player the request is sent to.

• #processed ⇒ Boolean

  Whether the request has been processed by the player.

• #response ⇒ String^?

  The player request response text (if the response is not a specific object).

• #screenshot ⇒ Player::Screenshot^?

  This field should be set once the action has been processed (see #processed) and the action is “send_screenshot”.

• #screenshot_id ⇒ Integer^?

  The ID of the player screenshot as a response to the action request “send_screenshot”.

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#dig, #reload, #rollback, #save

Instance Attribute Details

#action ⇒ "unknown", ...

Returns the player request action.

Returns:

• ("unknown", "send_logs", "clear_logs", "clear_content", "clear_layouts", "send_screenshot", "reboot", "retrieve_playlist", "os_switch_branch", "os_deploy", "os_pull", "restart_lc_session", "send_feedback", "apply_configuration") —

  the player request action

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

attribute :action

#argument ⇒ String^?

Returns the optional argument for the player request.

Returns:

• (String, nil) —

  the optional argument for the player request

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

attribute :argument

#feedback ⇒ Player::Feedback^?

This field should be set once the action has been processed (see #processed) and the action is “send_feedback”.

Returns:

• (Player::Feedback, nil) —

  the player feedback as a response to the action request “send_status”

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

belongs_to :feedback, class_name: "LWS::DigitalSignage::Player::Feedback",
uri: "players/:player_id/feedbacks/:id"

#feedback_id ⇒ Integer^?

Returns the ID of the player feedback as a response to the action request “send_status”.

Returns:

• (Integer, nil) —

  the ID of the player feedback as a response to the action request “send_status”

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

attribute :feedback_id

#log ⇒ Player::Log^?

This field should be set once the action has been processed (see #processed) and the action is “send_logs”.

Returns:

• (Player::Log, nil) —

  the player log as a response to the action request “send_logs”

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

belongs_to :log, class_name: "LWS::DigitalSignage::Player::Log",
uri: "players/:player_id/logs/:id"

#log_id ⇒ Integer^?

Returns the ID of the player log as a response to the action request “send_logs”.

Returns:

• (Integer, nil) —

  the ID of the player log as a response to the action request “send_logs”

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

attribute :log_id

#player ⇒ Player

Returns the player the request is sent to.

Returns:

• (Player) —

  the player the request is sent to

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

belongs_to :player, class_name: "LWS::DigitalSignage::Player"

#player_id ⇒ Integer

Returns the ID of the player the request is sent to.

Returns:

• (Integer) —

  the ID of the player the request is sent to

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

attribute :player_id

#processed ⇒ Boolean

Returns whether the request has been processed by the player.

Returns:

• (Boolean) —

  whether the request has been processed by the player

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

attribute :processed

#response ⇒ String^?

Returns the player request response text (if the response is not a specific object).

Returns:

• (String, nil) —

  the player request response text (if the response is not a specific object)

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

attribute :response

#screenshot ⇒ Player::Screenshot^?

This field should be set once the action has been processed (see #processed) and the action is “send_screenshot”.

Returns:

• (Player::Screenshot, nil) —

  the player screenshot as a response to the action request “send_screenshot”

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

belongs_to :screenshot, class_name: "LWS::DigitalSignage::Player::Screenshot",
uri: "players/:player_id/screenshots/:id"

#screenshot_id ⇒ Integer^?

Returns the ID of the player screenshot as a response to the action request “send_screenshot”.

Returns:

• (Integer, nil) —

  the ID of the player screenshot as a response to the action request “send_screenshot”

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

attribute :screenshot_id