aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/Wallabag/CoreBundle/Notifications/NotificationInterface.php
blob: fa226487d9caeb7013425778b9c06ba6f3497ea5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?php

namespace Wallabag\CoreBundle\Notifications;

use Psr\Log\LoggerAwareInterface;

interface NotificationInterface extends LoggerAwareInterface
{
    /**
     * Title of the notification.
     *
     * @return string
     */
    public function getTitle();

    /**
     * @param string $title
     *
     * @return NotificationInterface
     */
    public function setTitle($title);

    /**
     * Type of the notification.
     *
     * @return string
     */
    public function getType();

    /**
     * @param int $type
     *
     * @return NotificationInterface
     */
    public function setType($type);

    /**
     * If the notification has been viewed / dismissed or not.
     *
     * @return boolean
     */
    public function isRead();

    /**
     * @param boolean $read
     *
     * @return NotificationInterface
     */
    public function setRead($read);

    /**
     * When the notification was sent.
     *
     * @return \DateTime
     */
    public function getTimestamp();

    /**
     * @param \DateTime $timestamp
     *
     * @return NotificationInterface
     */
    public function setTimestamp(\DateTime $timestamp);

    /**
     * @param ActionInterface $action
     *
     * @return NotificationInterface
     */
    public function addAction(ActionInterface $action);

    /**
     * @return string
     */
    public function getDescription();

    /**
     * @param string $description
     *
     * @return NotificationInterface
     */
    public function setDescription($description);

    /**
     * @return array
     */
    public function getParameters();

    /**
     * @param array $parameters
     *
     * @return NotificationInterface
     */
    public function setParameters($parameters);

    /**
     * @param string $key
     * @param string $value
     *
     * @return NotificationInterface
     */
    public function addParameter($key, $value);
}