Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.file.notify.FileNotifyEntity Class Reference
Inheritance diagram for homeassistant.components.file.notify.FileNotifyEntity:
[legend]
Collaboration diagram for homeassistant.components.file.notify.FileNotifyEntity:
[legend]

Public Member Functions

None __init__ (self, str unique_id, dict[str, Any] config)
 
None send_message (self, str message, str|None title=None)
 
- Public Member Functions inherited from homeassistant.components.notify.NotifyEntity
None async_internal_added_to_hass (self)
 
None async_send_message (self, str message, str|None title=None)
 
str|None state (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 

Static Private Attributes

 _attr_icon = FILE_ICON
 
 _attr_supported_features = NotifyEntityFeature.TITLE
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.notify.NotifyEntity
 None
 
 NotifyEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Implement the notification entity platform for the File service.

Definition at line 33 of file notify.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.file.notify.FileNotifyEntity.__init__ (   self,
str  unique_id,
dict[str, Any]  config 
)
Initialize the service.

Definition at line 39 of file notify.py.

Member Function Documentation

◆ send_message()

None homeassistant.components.file.notify.FileNotifyEntity.send_message (   self,
str  message,
str | None   title = None 
)
Send a message to a file.

Reimplemented from homeassistant.components.notify.NotifyEntity.

Definition at line 47 of file notify.py.

Member Data Documentation

◆ _attr_icon

homeassistant.components.file.notify.FileNotifyEntity._attr_icon = FILE_ICON
staticprivate

Definition at line 36 of file notify.py.

◆ _attr_name

homeassistant.components.file.notify.FileNotifyEntity._attr_name
private

Definition at line 44 of file notify.py.

◆ _attr_supported_features

homeassistant.components.file.notify.FileNotifyEntity._attr_supported_features = NotifyEntityFeature.TITLE
staticprivate

Definition at line 37 of file notify.py.

◆ _attr_unique_id

homeassistant.components.file.notify.FileNotifyEntity._attr_unique_id
private

Definition at line 45 of file notify.py.


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