Package org.exoplatform.social.notification.service

Interface SpaceWebNotificationService

public interface SpaceWebNotificationService

  • Field Details

  • Method Details

    • addPlugin

      void addPlugin(SpaceWebNotificationPlugin spaceWebNotification)
      Register the space web notification plugin
      Parameters:
      spaceWebNotification -

    • dispatch

      void dispatch(org.exoplatform.commons.api.notification.model.NotificationInfo notification, String username) throws Exception
      Dispatch notification info
      Parameters:
      notification -
      username -
      Throws:
      Exception

    • markAsUnread

      void markAsUnread(SpaceWebNotificationItem notificationItem) throws Exception
      Mark a space notification item as unread
      Parameters:
      notificationItem -
      Throws:
      Exception

    • markAsRead

      void markAsRead(SpaceWebNotificationItem notificationItem) throws Exception
      Mark a space notification item as read
      Parameters:
      notificationItem -
      Throws:
      Exception

    • markAllAsRead

      void markAllAsRead(long userIdentityId, long spaceId) throws Exception
      Mark a list of unread items per application as read to a given MetadataItem creatorId by a given Space identifier
      Parameters:
      userIdentityId - MetadataItem creatorId
      spaceId - Space spaceId
      Throws:
      Exception

    • markAllAsRead

      void markAllAsRead(long userIdentityId) throws Exception
      Mark a list of unread items per application as read to a given MetadataItem creatorId
      Parameters:
      userIdentityId - MetadataItem creatorId
      Throws:
      Exception

    • countUnreadItemsByApplication

      Map<String,Long> countUnreadItemsByApplication(long creatorId, long spaceId)
      Get a list of unread items per application to a given MetadataItem creatorId by a given Space identifier
      Parameters:
      creatorId - MetadataItem creatorId
      spaceId - Space spaceId
      Returns:
      Map of application and unread items

    • countUnreadItemsBySpace

      Map<Long,Long> countUnreadItemsBySpace(String username)
      Get a list of unread items per space to a given MetadataItem
      Returns:
      Map of space id and unread items

    • getUnreadActivityIds

      List<Long> getUnreadActivityIds(String username, long offset, long limit)
      Parameters:
      username - User Identity remote id
      offset - offset of the query
      limit - offset of the query results
      Returns:
      List of ExoSocialActivity id

    • getUnreadActivityIdsBySpace

      List<Long> getUnreadActivityIdsBySpace(String username, long spaceId, long offset, long limit) throws IllegalAccessException, org.exoplatform.commons.exception.ObjectNotFoundException
      Parameters:
      username - User Identity remote id
      spaceId - Space id
      offset - offset of the query
      limit - offset of the query results
      Returns:
      List of ExoSocialActivity id
      Throws:
      IllegalAccessException - when user isn't member of space
      org.exoplatform.commons.exception.ObjectNotFoundException - when space not found

    • countUnreadActivities

      long countUnreadActivities(String username)
      Parameters:
      username - User Identity remote id
      Returns:
      count of unread activities

    • countUnreadActivitiesBySpace

      long countUnreadActivitiesBySpace(String username, long spaceId) throws IllegalAccessException, org.exoplatform.commons.exception.ObjectNotFoundException
      Parameters:
      username - User Identity remote id
      spaceId - Space id
      Returns:
      count of unread activities
      Throws:
      IllegalAccessException - when user isn't member of space
      org.exoplatform.commons.exception.ObjectNotFoundException - when space not found