src/Wallabag/CoreBundle/Notifications/NotificationInterface.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Notifications;
   4
   5 use Psr\Log\LoggerAwareInterface;
   6
   7 interface NotificationInterface extends LoggerAwareInterface
   8 {
   9     /**
  10      * Title of the notification.
  11      *
  12      * @return string
  13      */
  14     public function getTitle();
  15
  16     /**
  17      * @param string $title
  18      *
  19      * @return NotificationInterface
  20      */
  21     public function setTitle($title);
  22
  23     /**
  24      * Type of the notification.
  25      *
  26      * @return string
  27      */
  28     public function getType();
  29
  30     /**
  31      * @param int $type
  32      *
  33      * @return NotificationInterface
  34      */
  35     public function setType($type);
  36
  37     /**
  38      * If the notification has been viewed / dismissed or not.
  39      *
  40      * @return bool
  41      */
  42     public function isRead();
  43
  44     /**
  45      * @param bool $read
  46      *
  47      * @return NotificationInterface
  48      */
  49     public function setRead($read);
  50
  51     /**
  52      * When the notification was sent.
  53      *
  54      * @return \DateTime
  55      */
  56     public function getTimestamp();
  57
  58     /**
  59      * @param \DateTime $timestamp
  60      *
  61      * @return NotificationInterface
  62      */
  63     public function setTimestamp(\DateTime $timestamp);
  64
  65     /**
  66      * @param ActionInterface $action
  67      *
  68      * @return NotificationInterface
  69      */
  70     public function addAction(ActionInterface $action);
  71
  72     /**
  73      * @return string
  74      */
  75     public function getDescription();
  76
  77     /**
  78      * @param string $description
  79      *
  80      * @return NotificationInterface
  81      */
  82     public function setDescription($description);
  83
  84     /**
  85      * @return array
  86      */
  87     public function getParameters();
  88
  89     /**
  90      * @param array $parameters
  91      *
  92      * @return NotificationInterface
  93      */
  94     public function setParameters($parameters);
  95
  96     /**
  97      * @param string $key
  98      * @param string $value
  99      *
 100      * @return NotificationInterface
 101      */
 102     public function addParameter($key, $value);
 103 }