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

Interface UserNotificationOperationBuilder

public interface UserNotificationOperationBuilder

This interface provides specific builders to build operations to display a notification to a user. Please note that the built operations can only be executed for a User that is logged on as an agent in the novomind iAGENT Desk.

Since:

12.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UserNotificationOperationBuilder.Alert	This interface represents a specific builder to display a alert popup notification to a user.
static interface	UserNotificationOperationBuilder.Banner	This interface represents a specific builder to display a banner notification on the top of the browser to a user.
static interface	UserNotificationOperationBuilder.Desktop	This interface represents a specific builder to display a native desktop notification to a user.
static interface	UserNotificationOperationBuilder.Growl	This interface represents a specific builder to display a growl notification to a user.
static enum	UserNotificationOperationBuilder.Type	Specifies the different types of notifications.
static interface	UserNotificationOperationBuilder.WithCloseOption<T>	This interface represents a specific builder to display a notification with an option to be closed by the user.
static interface	UserNotificationOperationBuilder.WithDimensions<T>	This interface represents a specific builder to display a notification with dimensions.
static interface	UserNotificationOperationBuilder.WithDuration<T>	This interface represents a specific builder to display a notification with a duration.
static interface	UserNotificationOperationBuilder.WithHtmlIcon<T>	This interface represents a specific builder to display a notification with a custom html icon.
static interface	UserNotificationOperationBuilder.WithTitle<T>	This interface represents a specific builder to display a notification with a title.
static interface	UserNotificationOperationBuilder.WithType<T>	This interface represents a specific builder to display a notification with a UserNotificationOperationBuilder.Type.
static interface	UserNotificationOperationBuilder.WithUserIcon<T>	This interface represents a specific builder to display a notification with a user profile image as icon.

Method Summary

Modifier and Type	Method	Description
UserNotificationOperationBuilder.Alert	alert()	This method returns a UserNotificationOperationBuilder.Alert instance which is able to set the different parameters for building a user notification by an alert inline popup window.
UserNotificationOperationBuilder.Banner	banner()	This method returns a UserNotificationOperationBuilder.Banner instance which is able to set the different parameters for building a user notification by a banner notification on the top of the browser window.
UserNotificationOperationBuilder.Desktop	desktop()	This method returns a UserNotificationOperationBuilder.Desktop instance which is able to set the different parameters for building a user notification by a native desktop notification.
UserNotificationOperationBuilder.Growl	growl()	This method returns a UserNotificationOperationBuilder.Growl instance which is able to set the different parameters for building a user notification by a growl.

Method Details

alert

UserNotificationOperationBuilder.Alert alert()

This method returns a UserNotificationOperationBuilder.Alert instance which is able to set the different parameters for building a user notification by an alert inline popup window.

Returns:

the UserNotificationOperationBuilder.Alert

Since:

12.13

growl

UserNotificationOperationBuilder.Growl growl()

This method returns a UserNotificationOperationBuilder.Growl instance which is able to set the different parameters for building a user notification by a growl.

Returns:

the UserNotificationOperationBuilder.Growl

Since:

12.13

desktop

UserNotificationOperationBuilder.Desktop desktop()

This method returns a UserNotificationOperationBuilder.Desktop instance which is able to set the different parameters for building a user notification by a native desktop notification.

Returns:

the UserNotificationOperationBuilder.Desktop

Since:

12.13

banner

UserNotificationOperationBuilder.Banner banner()

This method returns a UserNotificationOperationBuilder.Banner instance which is able to set the different parameters for building a user notification by a banner notification on the top of the browser window.

Returns:

the UserNotificationOperationBuilder.Banner

Since:

13.0