Class: LWS::DigitalSignage::Player

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/digital_signage.rb

Overview

The player class

Defined Under Namespace

Modules: Os Classes: Component, Configuration, Log, Model, Notification, PredefinedConfiguration, Request, Screenshot, Tag

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

#channel ⇒ Channel

Returns the channel of the player.

Returns:

  • (Channel) —

    the channel of the player



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

belongs_to :channel, class_name: "LWS::DigitalSignage::Channel"

#channel_id ⇒ Integer

Returns the ID of the channel of the player.

Returns:

  • (Integer) —

    the ID of the channel of the player



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

attribute :channel_id

#company ⇒ LWS::Auth::Company

Returns the company the player belongs to.

Returns:



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

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

#company_id ⇒ Integer

Returns the ID of the company the player belongs to.

Returns:

  • (Integer) —

    the ID of the company the player belongs to



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

attribute :company_id

#component_ids ⇒ Array<Integer>

Returns the IDs of the components of the player.

Returns:

  • (Array<Integer>) —

    the IDs of the components of the player



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

attribute :component_ids

#components ⇒ Array<Player::Component>

Returns the components of the player.

Returns:



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

has_many :components, class_name: "LWS::DigitalSignage::Player::Component"

#configuration ⇒ Player::Configuration

Returns the configuration of the player.

Returns:



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

belongs_to :configuration, class_name: "LWS::DigitalSignage::Player::Configuration",
uri: "player/configurations/:id"

#configuration_id ⇒ Integer

Returns the ID of the configuration of the player.

Returns:

  • (Integer) —

    the ID of the configuration of the player



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

attribute :configuration_id

#feedback ⇒ Hash{String=>String}

Returns a mapping of player feedback key/values.

Returns:

  • (Hash{String=>String}) —

    a mapping of player feedback key/values



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

attribute :feedback

#health_percentage ⇒ Fixnum (readonly)

Returns the health of the player (percentage).

Returns:

  • (Fixnum) —

    the health of the player (percentage)



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

attribute :health_percentage

#hostname ⇒ String (readonly)

Returns the hostname used by the player (for DHCP for example).

Returns:

  • (String) —

    the hostname used by the player (for DHCP for example)



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

attribute :hostname

#log_ids ⇒ Array<Integer>

Returns the IDs of the logs of the player.

Returns:

  • (Array<Integer>) —

    the IDs of the logs of the player



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

attribute :log_ids

#logs ⇒ Array<Player::Log>

Returns the logs of the player.

Returns:



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

has_many :logs, class_name: "LWS::DigitalSignage::Player::Log"

#mac_lan ⇒ String?

Returns the MAC address of the LAN interface of the player.

Returns:

  • (String, nil) —

    the MAC address of the LAN interface of the player



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

attribute :mac_lan

#mac_wifi ⇒ String?

Returns the MAC address of the Wi-Fi interface of the player.

Returns:

  • (String, nil) —

    the MAC address of the Wi-Fi interface of the player



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

attribute :mac_wifi

#model ⇒ Player::Model

Returns the model of the player.

Returns:



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

belongs_to :model, class_name: "LWS::DigitalSignage::Player::Model",
uri: "player/models/:id"

#model_id ⇒ Integer

Returns the ID of the model of the player.

Returns:

  • (Integer) —

    the ID of the model of the player



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

attribute :model_id

#name ⇒ String

Returns the name of the player.

Returns:

  • (String) —

    the name of the player



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

attribute :name

#notification_ids ⇒ Array<Integer>

Returns the IDs of the notifications for the player.

Returns:

  • (Array<Integer>) —

    the IDs of the notifications for the player



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

attribute :notification_ids

#notifications ⇒ Array<Player::Notification>

Returns the notifications for the player.

Returns:



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

has_many :notifications, class_name: "LWS::DigitalSignage::Player::Notification"

#operation_hours ⇒ String? (readonly)

Returns the number of hours the player has been operational.

Returns:

  • (String, nil) —

    the number of hours the player has been operational



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

attribute :operation_hours

#operational_since ⇒ String? (readonly)

Returns the date/time when the player became operational for the first time.

Returns:

  • (String, nil) —

    the date/time when the player became operational for the first time



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

attribute :operational_since

#os_release_version ⇒ String?

Returns the OS version the player is using (if known).

Returns:

  • (String, nil) —

    the OS version the player is using (if known)



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

attribute :os_release_version

#part_ids ⇒ Array<Integer>

Returns the IDs of the parts of the player.

Returns:

  • (Array<Integer>) —

    the IDs of the parts of the player



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

attribute :part_ids

#parts ⇒ Array<Player::Component::Part>

Returns the parts of the player.

Returns:



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

has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part"

#recent_os ⇒ Boolean

Returns whether the OS of the player is recent.

Returns:

  • (Boolean) —

    whether the OS of the player is recent



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

attribute :recent_os

#registration_locked ⇒ Boolean

Returns whether registarion is locked for the player.

Returns:

  • (Boolean) —

    whether registarion is locked for the player



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

attribute :registration_locked

#release_channel ⇒ Player::Os::ReleaseChannel

Returns the player OS release channel used by the player.

Returns:



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

belongs_to :release_channel, class_name: "LWS::DigitalSignage::Player::Os::ReleaseChannel",
uri: "player/os/release_channels/:id"

#release_channel_id ⇒ Integer

Returns the ID of the player OS release channel used by the player.

Returns:

  • (Integer) —

    the ID of the player OS release channel used by the player



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

attribute :release_channel_id

#request_ids ⇒ Array<Integer>

Returns the IDs of the requests for the player.

Returns:

  • (Array<Integer>) —

    the IDs of the requests for the player



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

attribute :request_ids

#requests ⇒ Array<Player::Request>

Returns the requests for the player.

Returns:



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

has_many :requests, class_name: "LWS::DigitalSignage::Player::Request"

#screenshot_ids ⇒ Array<Integer>

Returns the IDs of the screenshots of the player.

Returns:

  • (Array<Integer>) —

    the IDs of the screenshots of the player



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

attribute :screenshot_ids

#screenshots ⇒ Array<Player::Screenshot>

Returns the screenshots of the player.

Returns:



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

has_many :screenshots, class_name: "LWS::DigitalSignage::Player::Screenshot"

#serial_number ⇒ String (readonly)

Returns the serial number of the player.

Returns:

  • (String) —

    the serial number of the player



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

attribute :serial_number

#service ⇒ Boolean

Returns whether the player is being serviced/is in service.

Returns:

  • (Boolean) —

    whether the player is being serviced/is in service



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

attribute :service

#service_reason ⇒ String?

Returns the reason the player is being serviced/is in service.

Returns:

  • (String, nil) —

    the reason the player is being serviced/is in service



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

attribute :service_reason

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

Returns the player status.

Returns:

  • ("unknown", "good", "warning", "bad") —

    the player status



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

attribute :status

#status_reason ⇒ "unknown", ... (readonly)

Returns the reason for the current player status.

Returns:

  • ("unknown", "hardware_failure", "outdated_os", "good", "connection_inactive_short", "connection_inactive_long") —

    the reason for the current player status



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

attribute :status_reason

#status_updated_at ⇒ String (readonly)

Returns the date/time the status was last updated.

Returns:

  • (String) —

    the date/time the status was last updated



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

attribute :status_updated_at

#tag_ids ⇒ Array<Tag>

Returns the IDs of the tags of the player.

Returns:

  • (Array<Tag>) —

    the IDs of the tags of the player



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

attribute :tag_ids

#tags ⇒ Array<Player::Tag>

Returns the tags of the player.

Returns:



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

has_many :tags, class_name: "LWS::DigitalSignage::Player::Tag"