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

Public Member Functions

None __init__ (self, FiveMDataUpdateCoordinator coordinator, FiveMEntityDescription description)
 
Mapping[str, Any]|None extra_state_attributes (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.fivem.coordinator.FiveMDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, Mapping[str, Any] config_data, str unique_id)
 
None initialize (self)
 
- 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

 entity_description
 
- Public Attributes inherited from homeassistant.components.fivem.coordinator.FiveMDataUpdateCoordinator
 game_name
 
 host
 
 server
 
 unique_id
 
 version
 
- 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_unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Representation of a FiveM base entity.

Definition at line 27 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fivem.entity.FiveMEntity.__init__ (   self,
FiveMDataUpdateCoordinator  coordinator,
FiveMEntityDescription  description 
)
Initialize base entity.

Definition at line 34 of file entity.py.

Member Function Documentation

◆ extra_state_attributes()

Mapping[str, Any] | None homeassistant.components.fivem.entity.FiveMEntity.extra_state_attributes (   self)
Return the extra attributes of the sensor.

Definition at line 53 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.fivem.entity.FiveMEntity._attr_device_info
private

Definition at line 44 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.fivem.entity.FiveMEntity._attr_has_entity_name = True
staticprivate

Definition at line 30 of file entity.py.

◆ _attr_unique_id

homeassistant.components.fivem.entity.FiveMEntity._attr_unique_id
private

Definition at line 43 of file entity.py.

◆ entity_description

homeassistant.components.fivem.entity.FiveMEntity.entity_description

Definition at line 41 of file entity.py.


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