NotificationSender (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.notification.user.client.NotificationSender

All Implemented Interfaces:

Serializable
```
public class NotificationSender
extends Object
implements Serializable
```
Sender of a notification to both the users in Silverpeas and to external users. The notification is defined by a NotificationMetaData instance. It uses the service of a NotificationManager object for doing its job.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor Description

protected NotificationSender()
Default constructor

NotificationSender(String instanceId)
Constructor for a standard component

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`notifyUser(int addressId, NotificationMetaData metaData)`	Sends at the specified address the notification whose definition is given by the specified `NotificationMetaData` instance.
`void`	`notifyUser(NotificationMetaData metaData)`	Sends the notification as defined by the specified `NotificationMetaData` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NotificationSender
```
protected NotificationSender()
```
    Default constructor
  - NotificationSender
```
public NotificationSender(String instanceId)
```
    Constructor for a standard component
    
    Parameters:
    
    instanceId - the instance Id of the calling's component
- Method Detail
  - notifyUser
```
public void notifyUser(NotificationMetaData metaData)
                throws NotificationException
```
    Sends the notification as defined by the specified NotificationMetaData instance.
    
    Parameters:
    
    metaData - the meta data of the notification. It defines the content of the notification as well as the recipients.
    
    Throws:
    
    NotificationException - if an error occurs while sending the notification.
  - notifyUser
```
public void notifyUser(int addressId,
                       NotificationMetaData metaData)
                throws NotificationException
```
    Sends at the specified address the notification whose definition is given by the specified NotificationMetaData instance.
    
    Parameters:
    
    addressId - the unique identifier of an address at which the notification has to be sent.
    
    metaData - the meta data of the notification. It defines the content of the notification as well as the recipients.
    
    Throws:
    
    NotificationException - if an error occurs while sending the notification.