Constants

METHOD_STREAM

METHOD_STREAM

METHOD_MAIL

METHOD_MAIL

PRIORITY_VERYLOW

PRIORITY_VERYLOW

PRIORITY_LOW

PRIORITY_LOW

PRIORITY_MEDIUM

PRIORITY_MEDIUM

PRIORITY_HIGH

PRIORITY_HIGH

PRIORITY_VERYHIGH

PRIORITY_VERYHIGH

Methods

getNotificationTypes()

getNotificationTypes(string  $languageCode) : array|false

The extension can return an array of additional notification types.

If no additional types are to be added false is to be returned

Parameters

string $languageCode

Returns

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_*], ]

getDefaultTypes()

getDefaultTypes(string  $method) : array|false

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.

Parameters

string $method

Returns

array|false

getTypeIcon()

getTypeIcon(string  $type) : string|false

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.

Parameters

string $type

Returns

string|false

translate()

translate(string  $app, string  $text, array  $params, boolean  $stripPath, boolean  $highlightParams, string  $languageCode) : string|false

The extension can translate a given message to the requested languages.

If no translation is available false is to be returned.

Parameters

string $app
string $text
array $params
boolean $stripPath
boolean $highlightParams
string $languageCode

Returns

string|false

getSpecialParameterList()

getSpecialParameterList(string  $app, string  $text) : array|false

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

Parameters

string $app
string $text

Returns

array|false

getGroupParameter()

getGroupParameter(array  $activity) : integer|false

The extension can define the parameter grouping by returning the index as integer.

In case no grouping is required false is to be returned.

Parameters

array $activity

Returns

integer|false

getNavigation()

getNavigation() : array|false

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.

Returns

array|false

isFilterValid()

isFilterValid(string  $filterValue) : boolean

The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.

Parameters

string $filterValue

Returns

boolean

filterNotificationTypes()

filterNotificationTypes(array  $types, string  $filter) : array|false

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.

Parameters

array $types
string $filter

Returns

array|false

getQueryForFilter()

getQueryForFilter(string  $filter) : array|false

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%'));

Parameters

string $filter

Returns

array|false