summaryrefslogtreecommitdiffstats
path: root/lib/public/activity/imanager.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-05-05 20:25:08 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-05-05 20:25:08 +0200
commit9185517bf0b4e9c2728453615447cf6271dbccb5 (patch)
tree4297c9e4c6e46b62a36dce9ef38d4cbc9c6b6c23 /lib/public/activity/imanager.php
parentba998670333b5430cd00dbce82a44f831ef34da1 (diff)
downloadnextcloud-server-9185517bf0b4e9c2728453615447cf6271dbccb5.tar.gz
nextcloud-server-9185517bf0b4e9c2728453615447cf6271dbccb5.zip
Move \OCP\Activity to PSR-4
Diffstat (limited to 'lib/public/activity/imanager.php')
-rw-r--r--lib/public/activity/imanager.php227
1 files changed, 0 insertions, 227 deletions
diff --git a/lib/public/activity/imanager.php b/lib/public/activity/imanager.php
deleted file mode 100644
index cbd08722410..00000000000
--- a/lib/public/activity/imanager.php
+++ /dev/null
@@ -1,227 +0,0 @@
-<?php
-/**
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
-
-/**
- * Public interface of ownCloud for apps to use.
- * Activity/IManager interface
- */
-
-// use OCP namespace for all classes that are considered public.
-// This means that they should be used by apps instead of the internal ownCloud classes
-namespace OCP\Activity;
-
-/**
- * Interface IManager
- *
- * @package OCP\Activity
- * @since 6.0.0
- */
-interface IManager {
- /**
- * Generates a new IEvent object
- *
- * Make sure to call at least the following methods before sending it to the
- * app with via the publish() method:
- * - setApp()
- * - setType()
- * - setAffectedUser()
- * - setSubject()
- *
- * @return IEvent
- * @since 8.2.0
- */
- public function generateEvent();
-
- /**
- * Publish an event to the activity consumers
- *
- * Make sure to call at least the following methods before sending an Event:
- * - setApp()
- * - setType()
- * - setAffectedUser()
- * - setSubject()
- *
- * @param IEvent $event
- * @return null
- * @since 8.2.0
- */
- public function publish(IEvent $event);
-
- /**
- * @param string $app The app where this event is associated with
- * @param string $subject A short description of the event
- * @param array $subjectParams Array with parameters that are filled in the subject
- * @param string $message A longer description of the event
- * @param array $messageParams Array with parameters that are filled in the message
- * @param string $file The file including path where this event is associated with
- * @param string $link A link where this event is associated with
- * @param string $affectedUser Recipient of the activity
- * @param string $type Type of the notification
- * @param int $priority Priority of the notification
- * @return null
- * @since 6.0.0
- * @deprecated 8.2.0 Grab an IEvent from generateEvent() instead and use the publish() method
- */
- public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
-
- /**
- * In order to improve lazy loading a closure can be registered which will be called in case
- * activity consumers are actually requested
- *
- * $callable has to return an instance of \OCP\Activity\IConsumer
- *
- * @param \Closure $callable
- * @return void
- * @since 6.0.0
- */
- public function registerConsumer(\Closure $callable);
-
- /**
- * In order to improve lazy loading a closure can be registered which will be called in case
- * activity consumers are actually requested
- *
- * $callable has to return an instance of \OCP\Activity\IExtension
- *
- * @param \Closure $callable
- * @return void
- * @since 8.0.0
- */
- public function registerExtension(\Closure $callable);
-
- /**
- * Will return additional notification types as specified by other apps
- *
- * @param string $languageCode
- * @return array Array "stringID of the type" => "translated string description for the setting"
- * or Array "stringID of the type" => [
- * 'desc' => "translated string description for the setting"
- * 'methods' => [\OCP\Activity\IExtension::METHOD_*],
- * ]
- * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
- */
- public function getNotificationTypes($languageCode);
-
- /**
- * @param string $method
- * @return array
- * @since 8.0.0
- */
- public function getDefaultTypes($method);
-
- /**
- * @param string $type
- * @return string
- * @since 8.0.0
- */
- public function getTypeIcon($type);
-
- /**
- * @param string $type
- * @param int $id
- * @since 8.2.0
- */
- public function setFormattingObject($type, $id);
-
- /**
- * @return bool
- * @since 8.2.0
- */
- public function isFormattingFilteredObject();
-
- /**
- * @param string $app
- * @param string $text
- * @param array $params
- * @param boolean $stripPath
- * @param boolean $highlightParams
- * @param string $languageCode
- * @return string|false
- * @since 8.0.0
- */
- public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
-
- /**
- * @param string $app
- * @param string $text
- * @return array|false
- * @since 8.0.0
- */
- public function getSpecialParameterList($app, $text);
-
- /**
- * @param array $activity
- * @return integer|false
- * @since 8.0.0
- */
- public function getGroupParameter($activity);
-
- /**
- * @return array
- * @since 8.0.0
- */
- public function getNavigation();
-
- /**
- * @param string $filterValue
- * @return boolean
- * @since 8.0.0
- */
- public function isFilterValid($filterValue);
-
- /**
- * @param array $types
- * @param string $filter
- * @return array
- * @since 8.0.0
- */
- public function filterNotificationTypes($types, $filter);
-
- /**
- * @param string $filter
- * @return array
- * @since 8.0.0
- */
- public function getQueryForFilter($filter);
-
-
- /**
- * Set the user we need to use
- *
- * @param string|null $currentUserId
- * @throws \UnexpectedValueException If the user is invalid
- * @since 9.0.1
- */
- public function setCurrentUserId($currentUserId);
-
- /**
- * Get the user we need to use
- *
- * Either the user is logged in, or we try to get it from the token
- *
- * @return string
- * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
- * @since 8.1.0
- */
- public function getCurrentUserId();
-}