blob: 17fffbb26e235f0b6c6b92b75366955e722632b3 (
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
|
<?php
/**
* SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Activity;
use OCP\Activity\Exceptions\UnknownActivityException;
/**
* Interface IProvider
*
* @since 11.0.0
*/
interface IProvider {
/**
* @param string $language The language which should be used for translating, e.g. "en"
* @param IEvent $event The current event which should be parsed
* @param IEvent|null $previousEvent A potential previous event which you can combine with the current one.
* To do so, simply use setChildEvent($previousEvent) after setting the
* combined subject on the current event.
* @return IEvent
* @throws UnknownActivityException Should be thrown if your provider does not know this event
* @since 11.0.0
* @since 30.0.0 Providers should throw {@see UnknownActivityException} instead of \InvalidArgumentException
* when they did not handle the event. Throwing \InvalidArgumentException directly is deprecated and will
* be logged as an error in Nextcloud 39.
*/
public function parse($language, IEvent $event, ?IEvent $previousEvent = null);
}
|
