diff options
| author | Frederic Guillot <fred@kanboard.net> | 2017-01-29 11:07:42 -0500 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2017-01-29 11:07:42 -0500 |
| commit | 0371acff89b14b9bdcb03e72fd9637e26e6b517c (patch) | |
| tree | f5878c9c07705379d137843cb8f92e3cdf7c20a8 /doc/plugin-notifications.markdown | |
| parent | 3bf4789be255650b64f42231f41383cb13b65572 (diff) | |
Move English documentation to folder en_US
Diffstat (limited to 'doc/plugin-notifications.markdown')
| -rw-r--r-- | doc/plugin-notifications.markdown | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/doc/plugin-notifications.markdown b/doc/plugin-notifications.markdown deleted file mode 100644 index 868f6aef..00000000 --- a/doc/plugin-notifications.markdown +++ /dev/null @@ -1,60 +0,0 @@ -Add Notification Types with Plugins -=================================== - -You can send notifications to almost any system by adding a new type. -There are two kinds of notifications: project and user. - -- Project: Notifications configured at the project level -- User: Notifications sent individually and configured at the user profile - -Register a new notification type --------------------------------- - -In your plugin registration file call the method `setType()`: - -```php -$this->userNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler'); -$this->projectNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler'); -``` - -Your handler can be registered for user or project notification. You don't necessarily need to support both. - -When your handler is registered, the end-user can choose to receive the new notification type or not. - -Notification Handler --------------------- - -Your notification handler must implement the interface `Kanboard\Core\Notification\NotificationInterface`: - -```php -interface NotificationInterface -{ - /** - * Send notification to a user - * - * @access public - * @param array $user - * @param string $event_name - * @param array $event_data - */ - public function notifyUser(array $user, $event_name, array $event_data); - - /** - * Send notification to a project - * - * @access public - * @param array $project - * @param string $event_name - * @param array $event_data - */ - public function notifyProject(array $project, $event_name, array $event_data); -} -``` - -Example of notification plugins -------------------------------- - -- [Slack](https://github.com/kanboard/plugin-slack) -- [Hipchat](https://github.com/kanboard/plugin-hipchat) -- [Jabber](https://github.com/kanboard/plugin-jabber) - |