nextcloud/lib/public/activity/imanager.php

170 lines
4.0 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @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>
*
2015-03-26 13:44:34 +03:00
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03:00
* 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.
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* 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 {
/**
* @param $app
* @param $subject
2013-10-09 20:06:21 +04:00
* @param $subjectParams
* @param $message
2013-10-09 20:06:21 +04:00
* @param $messageParams
* @param $file
* @param $link
2013-10-09 20:06:21 +04:00
* @param $affectedUser
* @param $type
* @param $priority
* @return mixed
* @since 6.0.0
*/
2013-10-09 20:06:21 +04:00
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
*/
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
*/
function registerExtension(\Closure $callable);
/**
* Will return additional notification types as specified by other apps
* @param string $languageCode
* @return array
* @since 8.0.0
*/
function getNotificationTypes($languageCode);
/**
* @param string $method
* @return array
* @since 8.0.0
*/
function getDefaultTypes($method);
/**
* @param string $type
* @return string
* @since 8.0.0
*/
function getTypeIcon($type);
/**
* @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
*/
function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
/**
* @param string $app
* @param string $text
* @return array|false
* @since 8.0.0
*/
function getSpecialParameterList($app, $text);
/**
* @param array $activity
* @return integer|false
* @since 8.0.0
*/
function getGroupParameter($activity);
/**
* @return array
* @since 8.0.0
*/
function getNavigation();
/**
* @param string $filterValue
* @return boolean
* @since 8.0.0
*/
function isFilterValid($filterValue);
/**
* @param array $types
* @param string $filter
* @return array
* @since 8.0.0
*/
function filterNotificationTypes($types, $filter);
/**
* @param string $filter
* @return array
* @since 8.0.0
*/
function getQueryForFilter($filter);
/**
* 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();
}