from typing import Optional

from office365.runtime.paths.resource_path import ResourcePath
from office365.sharepoint.entity import Entity


class Alert(Entity):
    """
    Represents an alert, which generates periodic e-mail notifications sent to a user about the list, list item,
    document, or document library to which the alert applies. SP.Alert provides information about the alert,
    such as which alert template is used, the alert frequency, and the UserID of the user who created the alert.

    The AlertTime, ItemID, ListID and ListUrl properties are not included in the default scalar property
    set for this type.
    """

    @property
    def alert_frequency(self):
        # type: () -> Optional[int]
        """Gets the time interval for sending the alert."""
        return self.properties.get("AlertFrequency", None)

    @property
    def alert_template_name(self):
        # type: () -> Optional[int]
        """Gets the string representing the alert template name."""
        return self.properties.get("AlertTemplateName", None)

    @property
    def always_notify(self):
        # type: () -> Optional[bool]
        """Gets a Boolean value that causes daily and weekly alerts to trigger, even if there is no matching event."""
        return self.properties.get("AlwaysNotify", None)

    @property
    def item(self):
        """Gets the list item or document to which the alert applies."""
        from office365.sharepoint.listitems.listitem import ListItem

        return self.properties.get(
            "Item", ListItem(self.context, ResourcePath("item", self.resource_path))
        )

    @property
    def user(self):
        """Gets user object that represents User for the alert."""
        from office365.sharepoint.principal.users.user import User

        return self.properties.get(
            "User", User(self.context, ResourcePath("user", self.resource_path))
        )

    @property
    def list(self):
        """Gets list object that represents List for the alert."""
        from office365.sharepoint.lists.list import List

        return self.properties.get(
            "List", List(self.context, ResourcePath("list", self.resource_path))
        )