Interface UserNotification
-
- All Known Implementing Classes:
DefaultUserNotification
,Notification
,NullUserNotification
,SimpleUserNotification
,UserNotificationWrapper
public interface UserNotification
A notification to a user. It is the main entry point in the User Notification API. AUserNotification
object can be obtained by theUserNotificationBuilder
object.- Author:
- Yohann Chastagnier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NotificationMetaData
getNotificationMetaData()
Gets the metadata about the notification to send so that all the properties required to send the notification can be set.void
send()
Sends this notification at the specified addresses declared within the metadata of this notification.void
send(BuiltInNotifAddress notificationAddress)
Sends this notification to the specified builtin user notification address.
-
-
-
Method Detail
-
getNotificationMetaData
NotificationMetaData getNotificationMetaData()
Gets the metadata about the notification to send so that all the properties required to send the notification can be set.- Returns:
- the notification metadata.
-
send
void send()
Sends this notification at the specified addresses declared within the metadata of this notification.
-
send
void send(BuiltInNotifAddress notificationAddress)
Sends this notification to the specified builtin user notification address.- Parameters:
notificationAddress
- the type of the media to vehicle the notification.
-
-