Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mobile_app.push_notification.PushChannel Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, str webhook_id, bool support_confirm, Callable[[dict], None] send_message, Callable[[], None] on_teardown)
 
bool async_confirm_notification (self, confirm_id)
 
def async_send_notification (self, data, fallback_send)
 
def async_teardown (self)
 

Public Attributes

 hass
 
 on_teardown
 
 support_confirm
 
 webhook_id
 

Private Attributes

 _send_message
 

Detailed Description

Class that represents a push channel.

Definition at line 15 of file push_notification.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mobile_app.push_notification.PushChannel.__init__ (   self,
HomeAssistant  hass,
str  webhook_id,
bool  support_confirm,
Callable[[dict], None]  send_message,
Callable[[], None]  on_teardown 
)
Initialize a local push channel.

Definition at line 18 of file push_notification.py.

Member Function Documentation

◆ async_confirm_notification()

bool homeassistant.components.mobile_app.push_notification.PushChannel.async_confirm_notification (   self,
  confirm_id 
)
Confirm a push notification.

Returns if confirmation successful.

Definition at line 67 of file push_notification.py.

◆ async_send_notification()

def homeassistant.components.mobile_app.push_notification.PushChannel.async_send_notification (   self,
  data,
  fallback_send 
)
Send a push notification.

Definition at line 35 of file push_notification.py.

◆ async_teardown()

def homeassistant.components.mobile_app.push_notification.PushChannel.async_teardown (   self)
Tear down this channel.

Definition at line 78 of file push_notification.py.

Member Data Documentation

◆ _send_message

homeassistant.components.mobile_app.push_notification.PushChannel._send_message
private

Definition at line 30 of file push_notification.py.

◆ hass

homeassistant.components.mobile_app.push_notification.PushChannel.hass

Definition at line 27 of file push_notification.py.

◆ on_teardown

homeassistant.components.mobile_app.push_notification.PushChannel.on_teardown

Definition at line 31 of file push_notification.py.

◆ support_confirm

homeassistant.components.mobile_app.push_notification.PushChannel.support_confirm

Definition at line 29 of file push_notification.py.

◆ webhook_id

homeassistant.components.mobile_app.push_notification.PushChannel.webhook_id

Definition at line 28 of file push_notification.py.


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