org.cyclos.impl.utils.appnotifications

Interface AppNotificationHandler

public interface AppNotificationHandler

Handler to send app notifications (aka push notifications)
Known implementations: FcmAppNotificationHandlerImpl

Author:

ameyer

Method Summary

Modifier and Type	Method and Description
boolean	canReceiveNotifications(BasicUser user) Returns whether the app notifications are configured for the user and it also has the required mediums to receive it (e.g an FCM registration token).
boolean	notify(org.cyclos.impl.utils.appnotifications.AppNotificationMessage notification) Sends (synchronously) a new app notification.
void	validate(BasicUser user, java.lang.Object medium) Validated the given medium used to send the app notification to the user.

Method Detail

canReceiveNotifications

boolean canReceiveNotifications(BasicUser user)

Returns whether the app notifications are configured for the user and it also has the required mediums to receive it (e.g an FCM registration token).
If false no notifications will be sent to this specific user.

notify

boolean notify(org.cyclos.impl.utils.appnotifications.AppNotificationMessage notification)

Sends (synchronously) a new app notification.

Returns:

whether the notification was sent or not.

validate

void validate(BasicUser user,
              java.lang.Object medium)

Validated the given medium used to send the app notification to the user. The medium depends on the underlying implementation, e.g in case of FCM it would be a token of type String.