org.deepamehta.notifications

Interface NotificationsService

All Known Implementing Classes:

NotificationsPlugin

public interface NotificationsService

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMAIL_SUBSCRIPTION
static String	IN_APP_SUBSCRIPTION
static String	INVOLVED_ITEM_ID
static String	NOTIFICATION
static String	NOTIFICATION_BODY
static String	NOTIFICATION_RECIPIENT_EDGE
static String	NOTIFICATION_SEEN
static String	NOTIFICATION_TITLE
static String	SUBSCRIBED_ITEM_ID
static String	SUBSCRIPTION_EDGE
static String	SUBSCRIPTION_TYPE

Method Summary

Modifier and Type	Method and Description
List<de.deepamehta.core.RelatedTopic>	getNotifications() Gets all notifications for the logged-in user.
List<de.deepamehta.core.RelatedTopic>	getSubscriptions() Gets all subscribed topics for the logged-in user.
List<de.deepamehta.core.RelatedTopic>	getUnseenNotifications() Gets all unread notifications for the logged-in user.
void	notifySubscribers(String title, String message, long actionAccountId, de.deepamehta.core.DeepaMehtaObject item) Creates new notifications for all users with a direct or indirect (tags) subscription to the given item.
void	subscribeInApp(long accountId, long itemId) Create a subscription edge for useraccount to item.
void	unsubscribe(long accountId, long itemId) Remove subscription (edge) for given user account and item.

Field Detail

NOTIFICATION

static final String NOTIFICATION

See Also:

Constant Field Values

NOTIFICATION_TITLE

static final String NOTIFICATION_TITLE

See Also:

Constant Field Values

NOTIFICATION_BODY

static final String NOTIFICATION_BODY

See Also:

Constant Field Values

INVOLVED_ITEM_ID

static final String INVOLVED_ITEM_ID

See Also:

Constant Field Values

SUBSCRIBED_ITEM_ID

static final String SUBSCRIBED_ITEM_ID

See Also:

Constant Field Values

NOTIFICATION_SEEN

static final String NOTIFICATION_SEEN

See Also:

Constant Field Values

SUBSCRIPTION_EDGE

static final String SUBSCRIPTION_EDGE

See Also:

Constant Field Values

NOTIFICATION_RECIPIENT_EDGE

static final String NOTIFICATION_RECIPIENT_EDGE

See Also:

Constant Field Values

SUBSCRIPTION_TYPE

static final String SUBSCRIPTION_TYPE

See Also:

Constant Field Values

IN_APP_SUBSCRIPTION

static final String IN_APP_SUBSCRIPTION

See Also:

Constant Field Values

EMAIL_SUBSCRIPTION

static final String EMAIL_SUBSCRIPTION

See Also:

Constant Field Values

Method Detail

subscribeInApp

void subscribeInApp(long accountId,
                    long itemId)

Create a subscription edge for useraccount to item.

Parameters:

accountId - topic-id of user account

itemId - topic-id of user account

unsubscribe

void unsubscribe(long accountId,
                 long itemId)

Remove subscription (edge) for given user account and item.

Parameters:

accountId - topic-id of user account

itemId - topic-id of subscribed item

notifySubscribers

void notifySubscribers(String title,
                       String message,
                       long actionAccountId,
                       de.deepamehta.core.DeepaMehtaObject item)

Creates new notifications for all users with a direct or indirect (tags) subscription to the given item. Notifications are created if the (given) item is either of TopicType "User Account" or of any other TopicType which has the TopicType=Tag as a child-type. In the latter case, all subscribers of the _Tag_ are notified.

Parameters:

title - title of the notification

message - text part of the notification

actionAccountId - topic-id of user account performing the action which leads to the notification of all others

item - item users can have subscribed (either "User Account" or any TopicType with "Tags" as child)

getSubscriptions

List<de.deepamehta.core.RelatedTopic> getSubscriptions()

Gets all subscribed topics for the logged-in user.

getNotifications

List<de.deepamehta.core.RelatedTopic> getNotifications()

Gets all notifications for the logged-in user.

getUnseenNotifications

List<de.deepamehta.core.RelatedTopic> getUnseenNotifications()

Gets all unread notifications for the logged-in user.