Package org.cyclos.impl.utils.notifications
-
Interface Summary Interface Description AccountNotificationsHandler Handler to sendNotificationRootType.ACCOUNTrelated notifications.AdminNotificationsHandler Handler to sendAdminNotificationTypenotifications to administrators.BrokeringNotificationsHandler Handler to sendNotificationRootType.BROKERINGrelated notifications.CustomNotificationSender Allows scripts to send custom notifications.EntityNotificationProcessingHandler<E extends SimpleEntity> Processes the notifications for a specificNotificationProcessingEntityType.
For each new constant of typeNotificationProcessingEntityTypeTHERE MUST BE a corresponding implementation of this interface.FeedbackAndReferenceNotificationsHandler Handler to sendNotificationRootType.FEEDBACK_AND_REFERENCErelated notifications.MailContentProducer Interface used to produceMailContentfor an e-mail being sentMailHandler A service that sends e-mails.MarketplaceBuyerNotificationsHandler Handler to sendNotificationRootType.MARKETPLACE_BUYERrelated notifications.MarketplaceSellerNotificationsHandler Handler to sendNotificationRootType.MARKETPLACE_SELLERrelated notifications.NotificationHandler Notify users about events on Cyclos, according to his/hers preferencesPersonalNotificationsHandler Interface used to sendNotificationRootType.PERSONALrelated notifications.UserNotificationsHandlerAccessor Accessor to get user handlers to send notifications to user. -
Class Summary Class Description AdminsToNotifyCacheKey Indicates an administrator's notification type and target entityApplyMailTemplateParams Parameters passed in when applying the e-mail templateCustomNotification Contains all information for sending a custom notificationCustomNotificationResult The result of a custom notification when sending synchronouslyFcmNotificationScriptResult Contains all properties that can be customized for a FCM notification through a notification script.MailContent Content in a sent e-mailMailContentProducer.MailContentBuilder Builder forMailContentusing translation keysMailProcessingContext Context (stored as JSON) for the an email sending.NotificationProcessingEntityType<E extends SimpleEntity> Contains the type of entities that have notifications pending for processing.
For each type, the notifications are processed asynchronously through its corresponding recurring task that read each entity and creates a background task execution that finally process it.
See each type to know in which specific cases the notifications are processed asynchronously.NotificationScriptResult Contains the result of a notification script (i.e with typeScriptType.NOTIFICATION)NotificationURL Contains URL data used in notifications.UserNotificationMapping Provides a mapping for all implementations ofUserNotificationType, which are enum classes that implement this interface, one perNotificationRootType. -
Enum Summary Enum Description CustomNotificationResult.SendStatus Indicates the status of sending a specific mediumMailTemplateVariable NotificationDateFormat Used in conjunction withDateFormatto specify the pattern used to format a parameter of typeDatein a notification. -
Annotation Types Summary Annotation Type Description AccountNotification Identifies which user notification of root typeNotificationRootType.ACCOUNTshould be sent by calling the accessor methodBrokeringNotification Identifies which user notification of root typeNotificationRootType.BROKERINGshould be sent by calling the accessor methodDateFormat Used to specify how a date parameter in a notification must be formatted.FeedbackAndReferenceNotification Identifies which user notification of root typeNotificationRootType.FEEDBACK_AND_REFERENCEshould be sent by calling the accessor methodMarketplaceBuyerNotification Identifies which user notification of root typeNotificationRootType.MARKETPLACE_BUYERshould be sent by calling the accessor methodMarketplaceSellerNotification Identifies which user notification of root typeNotificationRootType.MARKETPLACE_SELLERshould be sent by calling the accessor methodOfAmount Used to indicate that a parameter in a notification is a voucher with amount, which has appended the " of {0}" translation.PersonalNotification Identifies which user notification of root typeNotificationRootType.PERSONALshould be sent by calling the accessor methodTransactionNumber Used to indicate that a parameter in a notification is a transaction number.WithDescription Used to indicate that a parameter in a notification is a description, which has appended the " with description {0}" translation.