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

Public Member Functions

def __init__ (self, hass, vapid_prv, vapid_email, registrations, json_path)
 
def async_dismiss (self, **kwargs)
 
def dismiss (self, **kwargs)
 
def send_message (self, message="", **kwargs)
 
def targets (self)
 

Public Attributes

 registrations
 
 registrations_json_path
 

Private Member Functions

def _push_message (self, payload, **kwargs)
 

Private Attributes

 _vapid_email
 
 _vapid_prv
 

Detailed Description

Implement the notification service for HTML5.

Definition at line 403 of file notify.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.html5.notify.HTML5NotificationService.__init__ (   self,
  hass,
  vapid_prv,
  vapid_email,
  registrations,
  json_path 
)
Initialize the service.

Definition at line 406 of file notify.py.

Member Function Documentation

◆ _push_message()

def homeassistant.components.html5.notify.HTML5NotificationService._push_message (   self,
  payload,
**  kwargs 
)
private
Send the message.

Definition at line 487 of file notify.py.

◆ async_dismiss()

def homeassistant.components.html5.notify.HTML5NotificationService.async_dismiss (   self,
**  kwargs 
)
Dismisses a notification.

This method must be run in the event loop.

Definition at line 446 of file notify.py.

◆ dismiss()

def homeassistant.components.html5.notify.HTML5NotificationService.dismiss (   self,
**  kwargs 
)
Dismisses a notification.

Definition at line 438 of file notify.py.

◆ send_message()

def homeassistant.components.html5.notify.HTML5NotificationService.send_message (   self,
  message = "",
**  kwargs 
)
Send a message to a user.

Definition at line 453 of file notify.py.

◆ targets()

def homeassistant.components.html5.notify.HTML5NotificationService.targets (   self)
Return a dictionary of registered targets.

Definition at line 434 of file notify.py.

Member Data Documentation

◆ _vapid_email

homeassistant.components.html5.notify.HTML5NotificationService._vapid_email
private

Definition at line 409 of file notify.py.

◆ _vapid_prv

homeassistant.components.html5.notify.HTML5NotificationService._vapid_prv
private

Definition at line 408 of file notify.py.

◆ registrations

homeassistant.components.html5.notify.HTML5NotificationService.registrations

Definition at line 410 of file notify.py.

◆ registrations_json_path

homeassistant.components.html5.notify.HTML5NotificationService.registrations_json_path

Definition at line 411 of file notify.py.


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