notify.py

Go to the documentation of this file.

"""Support for Matrix notifications."""
 
from __future__ import annotations
 
from typing import Any
 
import voluptuous as vol
 
from homeassistant.components.notify import (
    ATTR_DATA,
    ATTR_MESSAGE,
    ATTR_TARGET,
    PLATFORM_SCHEMA as NOTIFY_PLATFORM_SCHEMA,
    BaseNotificationService,
)
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import RoomID
from .const import DOMAIN, SERVICE_SEND_MESSAGE
 
CONF_DEFAULT_ROOM = "default_room"
 
PLATFORM_SCHEMA = NOTIFY_PLATFORM_SCHEMA.extend(
    {vol.Required(CONF_DEFAULT_ROOM): cv.string}
)
 
 
def get_service(
    hass: HomeAssistant,
    config: ConfigType,
    discovery_info: DiscoveryInfoType | None = None,
) -> MatrixNotificationService:
    """Get the Matrix notification service."""
    return MatrixNotificationService(config[CONF_DEFAULT_ROOM])
 
 
class MatrixNotificationService(BaseNotificationService):
    """Send notifications to a Matrix room."""
 
    def __init__(self, default_room: RoomID) -> None:
        """Set up the Matrix notification service."""
        self._default_room_default_room = default_room
 
    def send_message(self, message: str = "", **kwargs: Any) -> None:
        """Send the message to the Matrix server."""
        target_rooms: list[RoomID] = kwargs.get(ATTR_TARGET) or [self._default_room_default_room]
        service_data = {ATTR_TARGET: target_rooms, ATTR_MESSAGE: message}
        if (data := kwargs.get(ATTR_DATA)) is not None:
            service_data[ATTR_DATA] = data
        self.hass.services.call(DOMAIN, SERVICE_SEND_MESSAGE, service_data=service_data)