Package io.jmix.notifications

Interface NotificationTypesRepository

All Known Implementing Classes:

NotificationTypesRepositoryImpl

@NullMarked
public interface NotificationTypesRepository

Service that allows to register notification types and get information about available ones.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	NotificationTypesRepository.NotificationTypeRegistrationMode

Method Summary

Modifier and Type	Method	Description
void	clear()	Unregisters all notification types.
Collection<NotificationType>	getAllTypes()	Gets all available notification types
Optional<NotificationType>	getTypeByNameOpt(@Nullable String name)	Tries to get notification type by provided name.
void	registerTypes(NotificationType... notificationTypes)	Registers provided notification types with NotificationTypesRepository.NotificationTypeRegistrationMode.STRICT mode.
void	registerTypes(NotificationTypesRepository.NotificationTypeRegistrationMode mode, NotificationType... notificationTypes)	Registers provided notification types with provided mode

Method Details

getAllTypes

Collection<NotificationType> getAllTypes()

Gets all available notification types

Returns:

collection of notification types

getTypeByNameOpt

Optional<NotificationType> getTypeByNameOpt(@Nullable String name)

Tries to get notification type by provided name.

Parameters:

name - type name

Returns:

Optional with found notification type or empty Optional if type with provided name not found

clear

void clear()

Unregisters all notification types.

registerTypes

void registerTypes(NotificationType... notificationTypes)

Registers provided notification types with NotificationTypesRepository.NotificationTypeRegistrationMode.STRICT mode.

Parameters:

notificationTypes - notification types

registerTypes

void registerTypes(NotificationTypesRepository.NotificationTypeRegistrationMode mode,
 NotificationType... notificationTypes)

Registers provided notification types with provided mode

Parameters:

mode - registration mode

notificationTypes - notification types