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

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::Player class.

The player request 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

#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



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

attribute :action

#argument ⇒ String?

Returns the optional argument for the player request.

Returns:

  • (String, nil) —

    the optional argument for the player request



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

attribute :argument

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



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

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”



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

attribute :log_id

#player ⇒ Player

Returns the player the request is sent to.

Returns:

  • (Player) —

    the player the request is sent to



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

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



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

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



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

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)



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

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”



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

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”



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

attribute :screenshot_id