Class ActiveNotifications

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.ActiveNotifications
All Implemented Interfaces:
Iterable<ActiveNotifications.Entry>

public class ActiveNotifications extends XMLRequest implements Iterable<ActiveNotifications.Entry>
Returns a list of active notifications.
  • Constructor Details

    • ActiveNotifications

      public ActiveNotifications()
  • Method Details

    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source
    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session
    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session
    • size

      public int size()
      Returns the number of active notifications.
      Returns:
      Notification count
    • iterator

      public Iterator<ActiveNotifications.Entry> iterator()
      Specified by:
      iterator in interface Iterable<ActiveNotifications.Entry>