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

Public Member Functions

None __init__ (self, DataUpdateCoordinator[dict[str, Any]] coordinator, ConfigEntry entry, EntityDescription description)
 
None async_added_to_hass (self)
 
None update_from_latest_data (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.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.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 

Private Member Functions

None _handle_coordinator_update (self)
 

Private Attributes

 _attr_extra_state_attributes
 
 _attr_unique_id
 
 _entry
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Define a base IQVIA entity.

Definition at line 18 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.iqvia.entity.IQVIAEntity.__init__ (   self,
DataUpdateCoordinator[dict[str, Any]]  coordinator,
ConfigEntry  entry,
EntityDescription  description 
)
Initialize.

Definition at line 23 of file entity.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.iqvia.entity.IQVIAEntity._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 38 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.iqvia.entity.IQVIAEntity.async_added_to_hass (   self)
Register callbacks.

Definition at line 46 of file entity.py.

◆ update_from_latest_data()

None homeassistant.components.iqvia.entity.IQVIAEntity.update_from_latest_data (   self)
Update the entity from the latest data.

Reimplemented in homeassistant.components.iqvia.sensor.IndexSensor, and homeassistant.components.iqvia.sensor.ForecastSensor.

Definition at line 60 of file entity.py.

Member Data Documentation

◆ _attr_extra_state_attributes

homeassistant.components.iqvia.entity.IQVIAEntity._attr_extra_state_attributes
private

Definition at line 32 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.iqvia.entity.IQVIAEntity._attr_has_entity_name = True
staticprivate

Definition at line 21 of file entity.py.

◆ _attr_unique_id

homeassistant.components.iqvia.entity.IQVIAEntity._attr_unique_id
private

Definition at line 33 of file entity.py.

◆ _entry

homeassistant.components.iqvia.entity.IQVIAEntity._entry
private

Definition at line 34 of file entity.py.

◆ entity_description

homeassistant.components.iqvia.entity.IQVIAEntity.entity_description

Definition at line 35 of file entity.py.


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