summaryrefslogtreecommitdiff
path: root/doc/es_ES/plugin-notifications.markdown
blob: e014cf63824d4b924fee2ec3a8a59a1be97f510a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
Agregar notificaciones con los tipos de plugin
==============================================

Puede enviar notificaciones a casi cualquier sistema mediante la adición de un nuevo tipo .
There are two kinds of notifications: project and user.

- Project: Notificaciones configuradas a nivel de proyecto
- Usuario: Notificaciones enviadas individualmente y configurada a cada perfil de usuario.

Registra un nuevo tipo de notificación
--------------------------------------

En tu archivo de registro del plugin llama el metodo `setType()`:

```php
$this->userNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
$this->projectNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
```

Su controlador puede ser registrado por el usuario o la notificación del proyecto. No necesariamente tienen que soportarlo .
Cuando tu handler es registrdo, el usuario final **end-user** puede elegir recibir el nuevo tipo de notificación o no 

Notificación de Handler
-----------------------

Su controlador de notificación debe implementar la interfaz `Kanboard\Core\Notification\NotificationInterface`:

```php
interface NotificationInterface
{
    /**
     * Envia notificación a un usuario
     *
     * @access public
     * @param  array     $user
     * @param  string    $event_name
     * @param  array     $event_data
     */
    public function notifyUser(array $user, $event_name, array $event_data);

    /**
     * Envia notificacion a un projecto
     *
     * @access public
     * @param  array     $project
     * @param  string    $event_name
     * @param  array     $event_data
     */
    public function notifyProject(array $project, $event_name, array $event_data);
}
```

Ejemplo de notificacion de plugins
---------------------------------

- [Slack](https://github.com/kanboard/plugin-slack)
- [Hipchat](https://github.com/kanboard/plugin-hipchat)
- [Jabber](https://github.com/kanboard/plugin-jabber)