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
This class is only used within the context of the LWS::DigitalSignage::Player class.
The player request class
Instance Attribute Summary collapse
-
#action ⇒ "unknown", ...
The player request action.
-
#argument ⇒ String?
The optional argument for 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 ⇒ 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
#deep_dup, #dig, #reload, #rollback, #save
Instance Attribute Details
#action ⇒ "unknown", ...
Returns the player request action.
1657 |
# File 'lib/lws/apps/digital_signage.rb', line 1657 attribute :action |
#argument ⇒ String?
Returns the optional argument for the player request.
1661 |
# File 'lib/lws/apps/digital_signage.rb', line 1661 attribute :argument |
#log ⇒ Player::Log?
This field should be set once the action has been processed (see #processed) and the action is “send_logs”.
1669 1670 |
# File 'lib/lws/apps/digital_signage.rb', line 1669 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”.
1675 |
# File 'lib/lws/apps/digital_signage.rb', line 1675 attribute :log_id |
#player ⇒ Player
Returns the player the request is sent to.
1679 |
# File 'lib/lws/apps/digital_signage.rb', line 1679 belongs_to :player, class_name: "LWS::DigitalSignage::Player" |
#player_id ⇒ Integer
Returns the ID of the player the request is sent to.
1683 |
# File 'lib/lws/apps/digital_signage.rb', line 1683 attribute :player_id |
#processed ⇒ Boolean
Returns whether the request has been processed by the player.
1687 |
# File 'lib/lws/apps/digital_signage.rb', line 1687 attribute :processed |
#response ⇒ String?
Returns the player request response text (if the response is not a specific object).
1692 |
# File 'lib/lws/apps/digital_signage.rb', line 1692 attribute :response |
#screenshot ⇒ Player::Screenshot?
This field should be set once the action has been processed (see #processed) and the action is “send_screenshot”.
1700 1701 |
# File 'lib/lws/apps/digital_signage.rb', line 1700 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”.
1706 |
# File 'lib/lws/apps/digital_signage.rb', line 1706 attribute :screenshot_id |