Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xbox.entity.XboxBaseEntity Class Reference
Inheritance diagram for homeassistant.components.xbox.entity.XboxBaseEntity:
[legend]
Collaboration diagram for homeassistant.components.xbox.entity.XboxBaseEntity:
[legend]

Public Member Functions

None __init__ (self, XboxUpdateCoordinator coordinator, str xuid, str attribute)
 
PresenceData|None data (self)
 
str|None entity_picture (self)
 
str|None name (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.xbox.coordinator.XboxUpdateCoordinator
None __init__ (self, HomeAssistant hass, XboxLiveClient client, SmartglassConsoleList consoles)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 

Public Attributes

 attribute
 
 xuid
 
- Public Attributes inherited from homeassistant.components.xbox.coordinator.XboxUpdateCoordinator
 data
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 

Private Attributes

 _attr_device_info
 
 _attr_entity_registry_enabled_default
 
 _attr_unique_id
 

Detailed Description

Base Sensor for the Xbox Integration.

Definition at line 14 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.xbox.entity.XboxBaseEntity.__init__ (   self,
XboxUpdateCoordinator  coordinator,
str  xuid,
str   attribute 
)
Initialize Xbox binary sensor.

Definition at line 17 of file entity.py.

Member Function Documentation

◆ data()

PresenceData | None homeassistant.components.xbox.entity.XboxBaseEntity.data (   self)
Return coordinator data for this console.

Definition at line 35 of file entity.py.

◆ entity_picture()

str | None homeassistant.components.xbox.entity.XboxBaseEntity.entity_picture (   self)
Return the gamer pic.

Definition at line 52 of file entity.py.

◆ name()

str | None homeassistant.components.xbox.entity.XboxBaseEntity.name (   self)
Return the name of the sensor.

Definition at line 40 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.xbox.entity.XboxBaseEntity._attr_device_info
private

Definition at line 26 of file entity.py.

◆ _attr_entity_registry_enabled_default

homeassistant.components.xbox.entity.XboxBaseEntity._attr_entity_registry_enabled_default
private

Definition at line 25 of file entity.py.

◆ _attr_unique_id

homeassistant.components.xbox.entity.XboxBaseEntity._attr_unique_id
private

Definition at line 24 of file entity.py.

◆ attribute

homeassistant.components.xbox.entity.XboxBaseEntity.attribute

Definition at line 23 of file entity.py.

◆ xuid

homeassistant.components.xbox.entity.XboxBaseEntity.xuid

Definition at line 22 of file entity.py.


The documentation for this class was generated from the following file: