2014-07-03 15:48:15 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Björn Schießle <bjoern@schiessle.org>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2014-07-03 15:48:15 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2014-07-03 15:48:15 +04:00
|
|
|
*
|
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.
|
2014-07-03 15:48:15 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2014-07-03 15:48:15 +04:00
|
|
|
* 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.
|
2014-07-03 15:48:15 +04:00
|
|
|
*
|
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/>
|
2014-07-03 15:48:15 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* Activity/IExtension interface
|
|
|
|
*/
|
|
|
|
|
2014-07-03 15:48:15 +04:00
|
|
|
// 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;
|
|
|
|
|
2015-04-16 18:00:08 +03:00
|
|
|
/**
|
|
|
|
* Interface IExtension
|
|
|
|
*
|
|
|
|
* @package OCP\Activity
|
|
|
|
* @since 8.0.0
|
|
|
|
*/
|
2014-07-03 15:48:15 +04:00
|
|
|
interface IExtension {
|
2015-05-22 13:31:15 +03:00
|
|
|
const METHOD_STREAM = 'stream';
|
|
|
|
const METHOD_MAIL = 'email';
|
2014-11-28 12:37:16 +03:00
|
|
|
|
|
|
|
const PRIORITY_VERYLOW = 10;
|
|
|
|
const PRIORITY_LOW = 20;
|
|
|
|
const PRIORITY_MEDIUM = 30;
|
|
|
|
const PRIORITY_HIGH = 40;
|
|
|
|
const PRIORITY_VERYHIGH = 50;
|
|
|
|
|
2014-07-03 15:48:15 +04:00
|
|
|
/**
|
|
|
|
* The extension can return an array of additional notification types.
|
|
|
|
* If no additional types are to be added false is to be returned
|
|
|
|
*
|
|
|
|
* @param string $languageCode
|
2015-05-22 13:31:15 +03:00
|
|
|
* @return array|false 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' => [self::METHOD_*],
|
|
|
|
* ]
|
2016-01-22 10:43:05 +03:00
|
|
|
* @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function getNotificationTypes($languageCode);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* For a given method additional types to be displayed in the settings can be returned.
|
|
|
|
* In case no additional types are to be added false is to be returned.
|
|
|
|
*
|
|
|
|
* @param string $method
|
|
|
|
* @return array|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function getDefaultTypes($method);
|
|
|
|
|
2015-02-13 13:51:55 +03:00
|
|
|
/**
|
|
|
|
* A string naming the css class for the icon to be used can be returned.
|
|
|
|
* If no icon is known for the given type false is to be returned.
|
|
|
|
*
|
|
|
|
* @param string $type
|
|
|
|
* @return string|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2015-02-13 13:51:55 +03:00
|
|
|
*/
|
|
|
|
public function getTypeIcon($type);
|
|
|
|
|
2014-07-03 15:48:15 +04:00
|
|
|
/**
|
|
|
|
* The extension can translate a given message to the requested languages.
|
|
|
|
* If no translation is available false is to be returned.
|
|
|
|
*
|
|
|
|
* @param string $app
|
|
|
|
* @param string $text
|
|
|
|
* @param array $params
|
|
|
|
* @param boolean $stripPath
|
|
|
|
* @param boolean $highlightParams
|
|
|
|
* @param string $languageCode
|
|
|
|
* @return string|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
|
|
|
|
|
2014-12-11 16:54:50 +03:00
|
|
|
/**
|
|
|
|
* The extension can define the type of parameters for translation
|
|
|
|
*
|
|
|
|
* Currently known types are:
|
|
|
|
* * file => will strip away the path of the file and add a tooltip with it
|
|
|
|
* * username => will add the avatar of the user
|
2016-11-03 14:06:22 +03:00
|
|
|
* * email => will add a mailto link
|
2014-12-11 16:54:50 +03:00
|
|
|
*
|
|
|
|
* @param string $app
|
|
|
|
* @param string $text
|
|
|
|
* @return array|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2014-12-11 16:54:50 +03:00
|
|
|
*/
|
2015-02-16 19:46:43 +03:00
|
|
|
public function getSpecialParameterList($app, $text);
|
2014-12-11 16:54:50 +03:00
|
|
|
|
2014-07-03 15:48:15 +04:00
|
|
|
/**
|
|
|
|
* The extension can define the parameter grouping by returning the index as integer.
|
|
|
|
* In case no grouping is required false is to be returned.
|
|
|
|
*
|
|
|
|
* @param array $activity
|
|
|
|
* @return integer|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function getGroupParameter($activity);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The extension can define additional navigation entries. The array returned has to contain two keys 'top'
|
|
|
|
* and 'apps' which hold arrays with the relevant entries.
|
|
|
|
* If no further entries are to be added false is no be returned.
|
|
|
|
*
|
|
|
|
* @return array|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2016-10-20 18:57:44 +03:00
|
|
|
* @deprecated 9.2.0 - Register an IFilter instead
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function getNavigation();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
|
|
|
|
*
|
|
|
|
* @param string $filterValue
|
|
|
|
* @return boolean
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2016-10-20 18:57:44 +03:00
|
|
|
* @deprecated 9.2.0 - Register an IFilter instead
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function isFilterValid($filterValue);
|
|
|
|
|
2015-02-13 13:51:55 +03:00
|
|
|
/**
|
|
|
|
* The extension can filter the types based on the filter if required.
|
|
|
|
* In case no filter is to be applied false is to be returned unchanged.
|
|
|
|
*
|
|
|
|
* @param array $types
|
|
|
|
* @param string $filter
|
|
|
|
* @return array|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2016-10-20 18:57:44 +03:00
|
|
|
* @deprecated 9.2.0 - Register an IFilter instead
|
2015-02-13 13:51:55 +03:00
|
|
|
*/
|
|
|
|
public function filterNotificationTypes($types, $filter);
|
|
|
|
|
2014-07-03 15:48:15 +04:00
|
|
|
/**
|
|
|
|
* For a given filter the extension can specify the sql query conditions including parameters for that query.
|
|
|
|
* In case the extension does not know the filter false is to be returned.
|
|
|
|
* The query condition and the parameters are to be returned as array with two elements.
|
|
|
|
* E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
|
|
|
|
*
|
|
|
|
* @param string $filter
|
|
|
|
* @return array|false
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 8.0.0
|
2016-10-20 18:57:44 +03:00
|
|
|
* @deprecated 9.2.0 - Register an IFilter instead
|
2014-07-03 15:48:15 +04:00
|
|
|
*/
|
|
|
|
public function getQueryForFilter($filter);
|
|
|
|
}
|