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.

• #created_at ⇒ String readonly

  The timestamp of when the player request was created.

• #feedback ⇒ Player::Feedback^?

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

• #feedback_id ⇒ Fixnum^?

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

• #id ⇒ Fixnum readonly

  The (unique) ID of the player request.

• #log ⇒ Player::Log^?

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

• #log_id ⇒ Fixnum^?

  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 ⇒ Fixnum

  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 ⇒ Fixnum^?

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

• #updated_at ⇒ String readonly

  The timestamp of when the player request was last updated.

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 1648

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 1652

attribute :argument

#created_at ⇒ String (readonly)

Returns the timestamp of when the player request was created.

Returns:

• (String) —

  the timestamp of when the player request was created

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

attribute :created_at

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

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

#feedback_id ⇒ Fixnum^?

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

Returns:

• (Fixnum, nil) —

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

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

attribute :feedback_id

#id ⇒ Fixnum (readonly)

Returns the (unique) ID of the player request.

Returns:

• (Fixnum) —

  the (unique) ID of the player request

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

attribute :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 1674

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

#log_id ⇒ Fixnum^?

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

Returns:

• (Fixnum, nil) —

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

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

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 1684

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

#player_id ⇒ Fixnum

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

Returns:

• (Fixnum) —

  the ID of the player the request is sent to

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

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 1692

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 1697

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 1705

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

#screenshot_id ⇒ Fixnum^?

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

Returns:

• (Fixnum, nil) —

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

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

attribute :screenshot_id

#updated_at ⇒ String (readonly)

Returns the timestamp of when the player request was last updated.

Returns:

• (String) —

  the timestamp of when the player request was last updated

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

attribute :updated_at