Package com.microstrategy.webapi

Interface IDSSXMLInbox

public interface IDSSXMLInbox

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

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_GetInboxMessages_blockBegin	Default value for the blockBegin parameter of the GetInboxMessages method
static int	DEFAULT_GetInboxMessages_blockCount	Default value for the blockCount parameter of the GetInboxMessages method
static java.lang.String	DEFAULT_GetInboxMessages_inboxFilter	Default value for the inboxFilter parameter of the GetInboxMessages method
static int	DEFAULT_GetInboxMessages_inboxFlags	Default value for the inboxFlags parameter of the GetInboxMessages method
static java.lang.String	DEFAULT_RemoveFromInbox_inboxFilter	Default value for the inboxFilter parameter of the RemoveFromInbox method
static int	DEFAULT_RemoveFromInbox_inboxFlags	Default value for the inboxFlags parameter of the RemoveFromInbox method
static int	DEFAULT_SaveToInbox_inboxFlags	Default value for the inboxFlags parameter of the SaveToInbox method
static int	DEFAULT_SaveToInbox_stateID	Default value for the stateID parameter of the SaveToInbox method

Method Summary

Modifier and Type	Method	Description
java.lang.String	DuplicateMessage(java.lang.String sessionID, java.lang.String messageID)	Duplicates a given message.
java.lang.String	DuplicateMessage(java.lang.String sessionID, java.lang.String messageID, java.lang.String displayName, int mode)	Duplicates a given message.
java.lang.String	GetInboxMessages(java.lang.String sessionID, int inboxFlags, int blockBegin, int blockCount, java.lang.String inboxFilter)	Retrieve inbox messages for a session.
boolean	IsMessageSaved(java.lang.String sessionID, java.lang.String messageID)	This method returns whether the given message is in the user's inbox.
java.lang.String	RemoveFromInbox(java.lang.String sessionID, java.lang.String inboxFilter, int deletionFlags)	Removes one or many messages from the Inbox.
java.lang.String	RemoveInboxMessage(java.lang.String sessionID, java.lang.String messageID, int deletionFlags)	Removes a single message from the Inbox.
void	SaveToInbox(java.lang.String sessionID, java.lang.String messageID, int inboxFlags, int stateID)	Save a given message to the inbox.
void	SetMessageStatus(java.lang.String sessionID, java.lang.String inboxFilter)	Assigns a specific status to one or more messages in the Inbox.
void	UpdateMessageDisplayName(java.lang.String sessionID, java.lang.String messageID, java.lang.String displayName)	Updates the display name of a given message.

Field Detail

DEFAULT_GetInboxMessages_inboxFlags

static final int DEFAULT_GetInboxMessages_inboxFlags

Default value for the inboxFlags parameter of the GetInboxMessages method

See Also:

Constant Field Values

DEFAULT_GetInboxMessages_blockBegin

static final int DEFAULT_GetInboxMessages_blockBegin

Default value for the blockBegin parameter of the GetInboxMessages method

See Also:

Constant Field Values

DEFAULT_GetInboxMessages_blockCount

static final int DEFAULT_GetInboxMessages_blockCount

Default value for the blockCount parameter of the GetInboxMessages method

See Also:

Constant Field Values

DEFAULT_GetInboxMessages_inboxFilter

static final java.lang.String DEFAULT_GetInboxMessages_inboxFilter

Default value for the inboxFilter parameter of the GetInboxMessages method

See Also:

Constant Field Values

DEFAULT_RemoveFromInbox_inboxFilter

static final java.lang.String DEFAULT_RemoveFromInbox_inboxFilter

Default value for the inboxFilter parameter of the RemoveFromInbox method

See Also:

Constant Field Values

DEFAULT_RemoveFromInbox_inboxFlags

static final int DEFAULT_RemoveFromInbox_inboxFlags

Default value for the inboxFlags parameter of the RemoveFromInbox method

See Also:

Constant Field Values

DEFAULT_SaveToInbox_inboxFlags

static final int DEFAULT_SaveToInbox_inboxFlags

Default value for the inboxFlags parameter of the SaveToInbox method

See Also:

Constant Field Values

DEFAULT_SaveToInbox_stateID

static final int DEFAULT_SaveToInbox_stateID

Default value for the stateID parameter of the SaveToInbox method

See Also:

Constant Field Values

Method Detail

DuplicateMessage

java.lang.String DuplicateMessage(java.lang.String sessionID,
                                  java.lang.String messageID)
                           throws MSTRWebAPIException

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.

DuplicateMessage

java.lang.String DuplicateMessage(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  java.lang.String displayName,
                                  int mode)
                           throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 8.0.2

GetInboxMessages

java.lang.String GetInboxMessages(java.lang.String sessionID,
                                  int inboxFlags,
                                  int blockBegin,
                                  int blockCount,
                                  java.lang.String inboxFilter)
                           throws MSTRWebAPIException

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.

IsMessageSaved

boolean IsMessageSaved(java.lang.String sessionID,
                       java.lang.String messageID)
                throws MSTRWebAPIException

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.

RemoveFromInbox

java.lang.String RemoveFromInbox(java.lang.String sessionID,
                                 java.lang.String inboxFilter,
                                 int deletionFlags)
                          throws MSTRWebAPIException

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.

RemoveInboxMessage

java.lang.String RemoveInboxMessage(java.lang.String sessionID,
                                    java.lang.String messageID,
                                    int deletionFlags)
                             throws MSTRWebAPIException

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.

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

SaveToInbox

void SaveToInbox(java.lang.String sessionID,
                 java.lang.String messageID,
                 int inboxFlags,
                 int stateID)
          throws MSTRWebAPIException

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.

SetMessageStatus

void SetMessageStatus(java.lang.String sessionID,
                      java.lang.String inboxFilter)
               throws MSTRWebAPIException

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.

UpdateMessageDisplayName

void UpdateMessageDisplayName(java.lang.String sessionID,
                              java.lang.String messageID,
                              java.lang.String displayName)
                       throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 9.0.0