Package org.exoplatform.commons.api.notification.service

Interface SendAllRecipientProvider

public interface SendAllRecipientProvider
Lists the users a send-all notification walks, page by page: the enabled users of the platform, the internal ones only when asked. A send-all uses the implementation registered in the portal container (a Kernel component, or a Spring bean whose class carries @Service, which the Kernel bridge exports), and walks the enabled users of the organization service when there is none. At most one implementation may be registered: with two, every send-all active on a channel fails.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getRecipients(boolean internalsOnly, String afterUsername, int limit)
     

  • Method Details

    • getRecipients

      List<String> getRecipients(boolean internalsOnly, String afterUsername, int limit)
      Parameters:
      internalsOnly - whether the external users are left out
      afterUsername - the last username of the previous page, excluded, or null for the first page
      limit - the maximum number of usernames returned
      Returns:
      the usernames that follow afterUsername, in ascending order; fewer than limit only on the last page