Package com.microstrategy.web.objects
Interface WebMessageStatusList
-
public interface WebMessageStatusList
This interface represents the list of inbox messages that are affected when calling theWebInboxSource.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 correspondingWebInboxSource
, add its ID and new status, and invoke thesetStatus()
method, for example, this code changes the status of one message to "unread":
To modify the status of multiple messages, you should first add all messages to the list and then callWebInboxSource webInboxSrc = session.getFactory().getInboxSource(); WebMessageStatusList messageStatusList = webInboxSrc.getMessageStatusList(); messageStatusList.add(message.getID(), com.microstrategy.webapi.EnumDSSXMLMessageStatus.DssXmlMessageStatusNewMsg); webInboxSrc.setStatus();
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 theEnumDSSXMLMessageStatus
enumeration.
-
clear
void clear()
Removes all messages from this list.
-
-