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



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

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



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

attribute :channel_id

#company ⇒ LWS::Auth::Company

Returns the company the player belongs to.

Returns:



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

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



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

attribute :company_id

#components ⇒ Array<Player::Component>

Returns the components of the player.

Returns:



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

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

#configuration ⇒ Player::Configuration

Returns the configuration of the player.

Returns:



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

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



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

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



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

attribute :feedback

#health_percentage ⇒ Fixnum (readonly)

Returns the health of the player (percentage).

Returns:

  • (Fixnum) —

    the health of the player (percentage)



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

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)



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

attribute :hostname

#logs ⇒ Array<Player::Log>

Returns the logs of the player.

Returns:



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

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



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

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



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

attribute :mac_wifi

#model ⇒ Player::Model

Returns the model of the player.

Returns:



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

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



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

attribute :model_id

#name ⇒ String

Returns the name of the player.

Returns:

  • (String) —

    the name of the player



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

attribute :name

#notifications ⇒ Array<Player::Notification>

Returns the notifications for the player.

Returns:



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

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



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

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



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

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)



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

attribute :os_release_version

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

Returns the parts of the player.

Returns:



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

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



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

attribute :recent_os

#registration_locked ⇒ Boolean

Returns whether registarion is locked for the player.

Returns:

  • (Boolean) —

    whether registarion is locked for the player



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

attribute :registration_locked

#release_channel ⇒ Player::Os::ReleaseChannel

Returns the player OS release channel used by the player.

Returns:



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

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



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

attribute :release_channel_id

#requests ⇒ Array<Player::Request>

Returns the requests for the player.

Returns:



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

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

#screenshots ⇒ Array<Player::Screenshot>

Returns the screenshots of the player.

Returns:



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

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



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

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



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

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



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

attribute :service_reason

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

Returns the player status.

Returns:

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

    the player status



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

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



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

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



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

attribute :status_updated_at

#tags ⇒ Array<Player::Tag>

Returns the tags of the player.

Returns:



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

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