NotificationHandler (Cyclos 4.14.14 Scripting API Documentation)

All Known Subinterfaces:

NotificationHandlerImplementor

All Known Implementing Classes:

NotificationHandlerImpl
```
public interface NotificationHandler
```
Notify users about events on Cyclos, according to his/hers preferences

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ATTR_ENTITY`	Script attribute: the related entity.
`static String`	`ATTR_TYPE`	Script attribute: the notification type AdminNotificationType or any of the UserNotificationType implementations Never null
`static String`	`ATTR_USER`	Script attribute: the user being notified Never null

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AdminNotificationsHandler`	`admin()`	It returns a handler to allow to notify administrators.
`UserNotificationsHandlerAccessor`	`user(BasicUser user)`	It returns an accessor used to get a handler to allow notify the specified user.
`String`	`withDescription(Transaction transaction)`	Returns either a text such as " with description [description]" or empty if the transaction has no description

- Field Detail
  - ATTR_USER
```
static final String ATTR_USER
```
    Script attribute: the user being notified Never null
    
    See Also:
    
    Constant Field Values
  - ATTR_TYPE
```
static final String ATTR_TYPE
```
    Script attribute: the notification type AdminNotificationType or any of the UserNotificationType implementations Never null
    
    See Also:
    
    Constant Field Values
  - ATTR_ENTITY
```
static final String ATTR_ENTITY
```
    Script attribute: the related entity. E.g. the Transaction for AccountNotificationType.AUTHORIZED_PAYMENT_CANCELED Never null
    
    See Also:
    
    Constant Field Values
- Method Detail
  - admin
```
AdminNotificationsHandler admin()
```
    It returns a handler to allow to notify administrators.
  - user
```
UserNotificationsHandlerAccessor user(BasicUser user)
```
    It returns an accessor used to get a handler to allow notify the specified user.
  - withDescription
```
String withDescription(Transaction transaction)
```
    Returns either a text such as " with description [description]" or empty if the transaction has no description