Package io.jmix.notifications.channel.impl

Class InAppNotificationChannel

java.lang.Object

io.jmix.notifications.channel.impl.InAppNotificationChannel

All Implemented Interfaces:

NotificationChannel

@Component("ntf_InAppNotificationChannel")
public class InAppNotificationChannel
extends Object
implements NotificationChannel

Default notification channel.

Sends notifications within application (to user UI).

Field Summary

Fields

Modifier and Type	Field	Description
protected InAppSubscribableChannelSupplier	channelSupplier
protected UnconstrainedDataManager	dataManager
static final String	NAME
protected UserSessionNotifier	userSessionNotifier

Constructor Summary

Constructors

Constructor	Description
InAppNotificationChannel()

Method Summary

Modifier and Type	Method	Description
String	getName()	Provides unique name of channel.
void	init()
protected void	notifyUserSession(String userName)
protected void	processMessage(org.springframework.messaging.Message<?> message)
boolean	send(Notification notification)	Sends provided notification via this notification channel.
protected void	storeNotification(Notification notification)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

userSessionNotifier

@Autowired(required=false)
protected UserSessionNotifier userSessionNotifier

dataManager

@Autowired
protected UnconstrainedDataManager dataManager

channelSupplier

@Autowired(required=false)
protected InAppSubscribableChannelSupplier channelSupplier

Constructor Details

InAppNotificationChannel

public InAppNotificationChannel()

Method Details

getName

public String getName()

Description copied from interface: NotificationChannel

Provides unique name of channel.

Specified by:

getName in interface NotificationChannel

Returns:

channel name

init

@EventListener(org.springframework.boot.context.event.ApplicationStartedEvent.class)
public void init()

send

public boolean send(Notification notification)

Description copied from interface: NotificationChannel

Sends provided notification via this notification channel.

Specified by:

send in interface NotificationChannel

Parameters:

notification - notification

Returns:

true if notification was successfully sent, false otherwise

processMessage

protected void processMessage(org.springframework.messaging.Message<?> message)

notifyUserSession

protected void notifyUserSession(String userName)

storeNotification

protected void storeNotification(Notification notification)