UserNotificationHelper (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.notification.user.builder.helper.UserNotificationHelper

@Singleton
public class UserNotificationHelper
extends Object

Author:: Yohann Chastagnier

Constructor Summary

Constructors
Constructor Description

UserNotificationHelper()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static NotificationMetaData`	`build(UserNotificationBuilder notificationBuilder)`	Builds a notification data container from a given builder
`static void`	`buildAndSend(UserNotificationBuilder notificationBuilder)`	Builds a notification data container from a given builder.
`static void`	`buildAndSend(BuiltInNotifAddress notificationAddress, UserNotificationBuilder notificationBuilder)`	Builds a notification data container from a given builder.
`static UserNotificationHelper`	`getInstance()`

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

- Constructor Detail
  - UserNotificationHelper
```
public UserNotificationHelper()
```
- Method Detail
  - buildAndSend
```
public static void buildAndSend(UserNotificationBuilder notificationBuilder)
```
    Builds a notification data container from a given builder. After that, sends the built notification
    
    Parameters:
    
    notificationBuilder - the builder to use to construct the notification
  - buildAndSend
```
public static void buildAndSend(BuiltInNotifAddress notificationAddress,
                                UserNotificationBuilder notificationBuilder)
```
    Builds a notification data container from a given builder. After that, sends the built notification for the given media type
    
    Parameters:
    
    notificationAddress - the built-in address at which the notification has to be sent.
    
    notificationBuilder - the builder to use to construct the notification.
  - build
```
public static NotificationMetaData build(UserNotificationBuilder notificationBuilder)
```
    Builds a notification data container from a given builder
    
    Parameters:
    
    notificationBuilder - the builder to use to construct the notification.
    
    Returns:
    
    the metadata about the notification that is built by the builder.
  - getInstance
```
public static UserNotificationHelper getInstance()
```
    Returns:
    
    a UserNotificationHelper instance.