KB32302: How to delete history list subscriptions using MicroStrategy Web SDK

This java snippet explains how to delete history list subscriptions using the Strategy Web SDK. For this logic to work, the user requires permissions to unsubscribe from subscriptions.
 

package com.mstr.standalone;
import java.util.ArrayList;
import java.util.List;
import com.Strategy.web.objects.*;

public class DeleteSubScription {
         private WebIServerSession isession;
         private WebObjectsFactory factory;
         private WebInboxSource inbox;
         public DeleteSubScription() {
                   factory = WebObjectsFactory.getInstance();
                   isession = factory.getIServerSession();
                   isession.setServerName("was-rrchang");
                   isession.setProjectName("Strategy Tutorial");
                   isession.setLogin("bkelt");
                   isession.setPassword("bkelt");
                   isession.setServerPort(34952);
                   isession.setClientID("127.0.0.1");
                   try {
                            isession.refresh();
                   } catch (WebObjectsException e) {
                            e.printStackTrace();
                   }
                  inbox = isession.getFactory().getInboxSource();
         }

         public static void main(String[] args) {
          DeleteSubScription historyList = new DeleteSubScription(); 
                   List<WebMessage> list = historyList.getMessages();
                   for (WebMessage message : list) {
                    //checks the message by Display name.
         if (message.getDisplayName().indexOf("Unit Tracking by Supplier")>=0)
         {
           try {
             // This deletes the subscription for the user logged in 
             // as long the user has permission to un-subscribe this subscription             
             message.removeFromInbox();
 
                          } catch (WebObjectsException e) {
                                 e.printStackTrace();
                        }
         }
                   }
         }
         
         // Getting the list of message from History List
         public List<WebMessage> getMessages() {
                   List<WebMessage> list = new ArrayList<WebMessage>();
                   try {
                      //Getting the inbox messages
                            WebMessages messages = inbox.getInboxMessages();
                            for (int i = 0; i < messages.size(); i++) {
                                     WebMessage message = messages.get(i);
                                     list.add(message);
                            }
                   } catch (WebObjectsException e) {
                            e.printStackTrace();
                   }
                   return list;
         }
}

 

The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.Strategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@Strategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.Strategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.