public interface

IDSSXMLInbox

com.microstrategy.webapi.IDSSXMLInbox

Class Overview

This interface provides access to the messaging functionality of the Intelligence Server.

Summary

Constants
int DEFAULT_GetInboxMessages_blockBegin Default value for the blockBegin parameter of the GetInboxMessages method
int DEFAULT_GetInboxMessages_blockCount Default value for the blockCount parameter of the GetInboxMessages method
String DEFAULT_GetInboxMessages_inboxFilter Default value for the inboxFilter parameter of the GetInboxMessages method
int DEFAULT_GetInboxMessages_inboxFlags Default value for the inboxFlags parameter of the GetInboxMessages method
String DEFAULT_RemoveFromInbox_inboxFilter Default value for the inboxFilter parameter of the RemoveFromInbox method
int DEFAULT_RemoveFromInbox_inboxFlags Default value for the inboxFlags parameter of the RemoveFromInbox method
int DEFAULT_SaveToInbox_inboxFlags Default value for the inboxFlags parameter of the SaveToInbox method
int DEFAULT_SaveToInbox_stateID Default value for the stateID parameter of the SaveToInbox method
Public Methods
abstract String DuplicateMessage(String sessionID, String messageID)
Duplicates a given message.
abstract String DuplicateMessage(String sessionID, String messageID, String displayName, int mode)
Duplicates a given message.
abstract String GetInboxMessages(String sessionID, int inboxFlags, int blockBegin, int blockCount, String inboxFilter)
Retrieve inbox messages for a session.
abstract boolean IsMessageSaved(String sessionID, String messageID)
This method returns whether the given message is in the user's inbox.
abstract String RemoveFromInbox(String sessionID, String inboxFilter, int deletionFlags)
Removes one or many messages from the Inbox.
abstract String RemoveInboxMessage(String sessionID, String messageID, int deletionFlags)
Removes a single message from the Inbox.
abstract void SaveToInbox(String sessionID, String messageID, int inboxFlags, int stateID)
Save a given message to the inbox.
abstract void SetMessageStatus(String sessionID, String inboxFilter)
Assigns a specific status to one or more messages in the Inbox.
abstract void UpdateMessageDisplayName(String sessionID, String messageID, String displayName)
Updates the display name of a given message.

Constants

public static final int DEFAULT_GetInboxMessages_blockBegin

Default value for the blockBegin parameter of the GetInboxMessages method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_GetInboxMessages_blockCount

Default value for the blockCount parameter of the GetInboxMessages method

Constant Value: -1 (0xffffffff)

public static final String DEFAULT_GetInboxMessages_inboxFilter

Default value for the inboxFilter parameter of the GetInboxMessages method

Constant Value: ""

public static final int DEFAULT_GetInboxMessages_inboxFlags

Default value for the inboxFlags parameter of the GetInboxMessages method

Constant Value: 1 (0x00000001)

public static final String DEFAULT_RemoveFromInbox_inboxFilter

Default value for the inboxFilter parameter of the RemoveFromInbox method

Constant Value: ""

public static final int DEFAULT_RemoveFromInbox_inboxFlags

Default value for the inboxFlags parameter of the RemoveFromInbox method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_SaveToInbox_inboxFlags

Default value for the inboxFlags parameter of the SaveToInbox method

Constant Value: 5 (0x00000005)

public static final int DEFAULT_SaveToInbox_stateID

Default value for the stateID parameter of the SaveToInbox method

Constant Value: -1 (0xffffffff)

Public Methods

public abstract String DuplicateMessage (String sessionID, String messageID)

Duplicates a given message.

This method can be used in the situation when a user wants to manipulate a report (drill, page-by etc.) in a document. When performing any manipulation on a report in a document, the report will be manipulated independent of the document that it belongs to. These manipulation actions should be performed on a messageID that is a duplicate of the report that the user wants to perform the manipulation on.

This is equivalent to invoking DuplicateMessage(String, String, String, int) with a null display name, and EnumDSSXMLMessageDuplicationMode#DSSXMLMessageDuplicateModeLegacy.

Parameters
sessionID A valid Session ID.
messageID The message ID of the message to be copied.
Returns
  • The message ID of the new message.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String DuplicateMessage (String sessionID, String messageID, String displayName, int mode)

Duplicates a given message.

This method can be used in the situation when a user wants to manipulate a report (drill, page-by etc.) in a document. When performing any manipulation on a report in a document, the report will be manipulated independent of the document that it belongs to. These manipulation actions should be performed on a messageID that is a duplicate of the report that the user wants to perform the manipulation on.

Parameters
sessionID A valid Session ID.
messageID The message ID of the message to be copied.
displayName optional message alias
mode constant from EnumDSSXMLMessageDuplicationMode
Returns
  • The message ID of the new message.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetInboxMessages (String sessionID, int inboxFlags, int blockBegin, int blockCount, String inboxFilter)

Retrieve inbox messages for a session. The application can specify part or all messages will be returned.

blockBegin and blockCount allow the application to retrieve inbox messages incrementally. blockBegin can range from 1 to the number of messages in the inbox. Using a blockCount of -1 returns all messages starting at the message specified in blockBegin. The application can get the total message count in an inbox by looking at the inbox XML’s cn attribute.

With the inboxFilter parameter, a user can specify the messages to be retrieved. This parameter is an XML String.

Parameters
sessionID A valid Session ID.
inboxFlags Indicates the information that will be returned from the call. This value comes from EnumDSSXMLInboxFlags. [Default=DssXmlInboxBrowsingInfo]
blockBegin The first element to return (used in incremental fetch). [Default=1]
blockCount The number of elements to return (used in incremental fetch). [Default=-1]
inboxFilter The XML of a filter to apply to the inbox. [Default=""]
Returns
  • XML String representing the current inbox.
Throws
MSTRWebAPIException Signals an error condition.

public abstract boolean IsMessageSaved (String sessionID, String messageID)

This method returns whether the given message is in the user's inbox.

Parameters
sessionID session id
messageID message id
Returns
  • True if the message is saved, false otherwise.
Throws
MSTRWebAPIException Thrown when an error occurs during retrieve the information.

public abstract String RemoveFromInbox (String sessionID, String inboxFilter, int deletionFlags)

Removes one or many messages from the Inbox. If any of the jobs being removed are still executing, this call will cause the job to be cancelled.

Parameters
sessionID A valid Session ID.
inboxFilter Optional inboxFilter to specify the messages to be removed. Default is an empty string, which means remove all inbox messages. [Default=""]
deletionFlags Optional parameter from EnumDSSXMLInboxDeleteFlags.
Returns
  • XML of the deleted messages (not currently supported).
Throws
MSTRWebAPIException Signals an error condition.

public abstract String RemoveInboxMessage (String sessionID, String messageID, int deletionFlags)

Removes a single message from the Inbox. If any of the jobs being removed are still executing, this call will cause the job to be cancelled.@return

Parameters
sessionID A valid Session ID.
messageID The message ID The message ID to remove.
deletionFlags The flags with regards to where to remove the message from.
Returns
  • XML of the deleted messages (not currently supported).
Throws
MSTRWebAPIException

public abstract void SaveToInbox (String sessionID, String messageID, int inboxFlags, int stateID)

Save a given message to the inbox.

This method is used to save a given message into the user inbox. A message can be saved in the inbox in two ways. You can have the inbox always keep the latest report result or keep the report result "as is". This is controlled by the inboxFlags parameter.

A report can be manipulated many times. For example, a report can be pivoted twice and then sorted. The report state after each manipulation is identified by an ID. The initial state of any report is identified by a state ID of 0. Each manipulation will increment the ID by 1. The stateID parameter is used to identify a report state. When specified, the inbox will save the report in the given state. The default is to save the final state of the report.

Parameters
sessionID A valid Session ID.
messageID The message ID of the message to save.
inboxFlags Indicates the information that will be returned from the call. This value comes from EnumDSSXMLInboxFlags. [Default=DssXmlInboxBrowsingInfo]
stateID An ID that is used to identify the report manipulation state. [Default=-1]
Throws
MSTRWebAPIException Signals an error condition.

public abstract void SetMessageStatus (String sessionID, String inboxFilter)

Assigns a specific status to one or more messages in the Inbox. The inboxFilter parameter consists of an XML definition for setting the status of each message.

The status of an inbox message comes from the enumeration EnumDSSXMLMessageStatus.

Parameters
sessionID A valid Session ID.
inboxFilter Messages and their new status in XML format.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void UpdateMessageDisplayName (String sessionID, String messageID, String displayName)

Updates the display name of a given message.

Parameters
sessionID A valid Session ID.
messageID The message ID of the message to save.
displayName the new display name
Throws
MSTRWebAPIException Signals an error condition.