summaryrefslogtreecommitdiffstats
path: root/lib/public/Notification/IApp.php
blob: 1574ae8a091100366ecca7dee3730a913aa45387 (plain)
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
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\Notification;

/**
 * Interface IApp
 *
 * @since 9.0.0
 */
interface IApp {
	/**
	 * @param INotification $notification
	 * @throws IncompleteNotificationException When the notification does not have all required fields set
	 * @since 9.0.0
	 * @since 30.0.0 throws {@see IncompleteNotificationException} instead of \InvalidArgumentException
	 */
	public function notify(INotification $notification): void;

	/**
	 * @param INotification $notification
	 * @since 9.0.0
	 */
	public function markProcessed(INotification $notification): void;

	/**
	 * @param INotification $notification
	 * @return int
	 * @since 9.0.0
	 */
	public function getCount(INotification $notification): int;
}