Interface WebMessageStatusList


  • public interface WebMessageStatusList
    This interface represents the list of inbox messages that are affected when calling the WebInboxSource.setStatus() method. Only messages explicitly added to this list will change their status when calling this method.
    To modify the status of an inbox message you obtain this list from the corresponding WebInboxSource, add its ID and new status, and invoke the setStatus() method, for example, this code changes the status of one message to "unread":
     WebInboxSource webInboxSrc = session.getFactory().getInboxSource();
     WebMessageStatusList messageStatusList = webInboxSrc.getMessageStatusList();
    
     messageStatusList.add(message.getID(), com.microstrategy.webapi.EnumDSSXMLMessageStatus.DssXmlMessageStatusNewMsg);
     webInboxSrc.setStatus();
     
    To modify the status of multiple messages, you should first add all messages to the list and then call setStatus().
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(java.lang.String strAddMsgID, int status)
      Appends the given message ID and new status to the WebMessageStatusList.
      void clear()
      Removes all messages from this list.
    • Method Detail

      • add

        void add​(java.lang.String strAddMsgID,
                 int status)
        Appends the given message ID and new status to the WebMessageStatusList.
        Parameters:
        strAddMsgID - Inbox Message ID.
        status - The new status to give to this message ID, a value from the EnumDSSXMLMessageStatus enumeration.
      • clear

        void clear()
        Removes all messages from this list.