Package com.novomind.ecom.api.iagent.operation.notification

Interface UserNotificationOperationBuilder.Growl

All Superinterfaces:

UserNotificationOperationBuilder.WithDuration<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithHtmlIcon<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithTitle<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithType<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithUserIcon<UserNotificationOperationBuilder.Growl>

Enclosing interface:

UserNotificationOperationBuilder

public static interface UserNotificationOperationBuilder.Growl
extends UserNotificationOperationBuilder.WithType<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithDuration<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithTitle<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithHtmlIcon<UserNotificationOperationBuilder.Growl>, UserNotificationOperationBuilder.WithUserIcon<UserNotificationOperationBuilder.Growl>

This interface represents a specific builder to display a growl notification to a user.

Since:

12.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UserNotificationOperationBuilder.Growl.Html	This interface represents a specific builder to display a growl notification with a html message to a user.
static interface	UserNotificationOperationBuilder.Growl.Text	This interface represents a specific builder to display a growl notification with a plain text message to a user.
static interface	UserNotificationOperationBuilder.Growl.WithMessage<T>	This interface represents a specific builder to display a growl notification with a message to a user.

Method Summary

Modifier and Type	Method	Description
UserNotificationOperationBuilder.Growl.Html	html(String html)	This method returns a UserNotificationOperationBuilder.Growl.Html instance which is able to display a user notification with a html message.
UserNotificationOperationBuilder.Growl.Text	text(String text)	This method returns a UserNotificationOperationBuilder.Growl.Text instance which is able to display a user notification with a text message.

Methods inherited from interface com.novomind.ecom.api.iagent.operation.notification.UserNotificationOperationBuilder.WithDuration

duration

Methods inherited from interface com.novomind.ecom.api.iagent.operation.notification.UserNotificationOperationBuilder.WithHtmlIcon

htmlIcon

Methods inherited from interface com.novomind.ecom.api.iagent.operation.notification.UserNotificationOperationBuilder.WithTitle

title

Methods inherited from interface com.novomind.ecom.api.iagent.operation.notification.UserNotificationOperationBuilder.WithType

type

Methods inherited from interface com.novomind.ecom.api.iagent.operation.notification.UserNotificationOperationBuilder.WithUserIcon

userIcon

Method Details

text

UserNotificationOperationBuilder.Growl.Text text(String text)
                                          throws ValidationException

This method returns a UserNotificationOperationBuilder.Growl.Text instance which is able to display a user notification with a text message.

Parameters:

text - the text message of the growl notification

Returns:

the UserNotificationOperationBuilder.Growl.Text

Throws:

ValidationException - if the text message is not valid

Since:

12.13

html

UserNotificationOperationBuilder.Growl.Html html(String html)
                                          throws ValidationException

This method returns a UserNotificationOperationBuilder.Growl.Html instance which is able to display a user notification with a html message. The parameter should only contain simple html elements like div, span, a, b. Not allowed are elements like iframe, embed, script, etc. Any type of script or event handler is also not allowed.

Parameters:

html - the html message of the growl notification

Returns:

the UserNotificationOperationBuilder.Growl.Html

Throws:

ValidationException - if the html message is not valid

Since:

12.13