Supported Bean: InboxBean
InboxBean interface allows the users to manage their
History List. The main functionalities it provides in this interface are:
Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_INBOX (16)
Events
| CancelRenameMsg | ||||
Cancels the EnumInboxBeanEvents.INBOX_EVENT_EDIT_RENAME_MESSAGE state. |
16016 | |||
| DuplicateInboxMessages | ||||
| Specifies an event to duplicate Inbox messages. |
16005 | |||
|
*msgIDs | Specifies an argument for message ids |
16205 | ||
| EditRenameMsg | ||||
| Configures a message as editable. |
16014 | |||
|
msgID |
16226 | |||
| HighlightAllMessages | ||||
| Specifies an event to highlight all messages. |
16009 | |||
|
details | Specifies an argument for the Highlighting. True if during highlighting, one wants to specify that details should be added. |
16212 | ||
| HighlightMessages | ||||
| Specifies an event to select/unselect all messages. |
16010 | |||
|
*messageIDs | Specifies an argument for message ids |
16205 | ||
|
details | Specifies an argument for the Highlighting. True if during highlighting, one wants to specify that details should be added. |
16212 | ||
| NewMsgName | ||||
Renames a message previously configured as editable
EnumInboxBeanEvents.INBOX_EVENT_EDIT_RENAME_MESSAGE with a new name. |
16015 | |||
|
msgID |
16226 | |||
|
newName | Specifies an argument for message name. |
16227 | ||
| ProcessInbox | ||||
| Specifies an event to process any supported user action.
This event looks for the user action passed as an action argument
and then executes the action if there is any User action argument, which
informs the event what arguments to look for and what to do, has the
prefix
This event includes almost all the event arguments
defined in this interface. Depending on an action, users can pass in
any partial arguments necessary for this particular action. As a hint to
what arguments are necessary, look for those defined in the
corresponding smaller event. For example, if the user action is to
remove some inbox messages as specified by the action argument
Although all arguments are optional for the whole event due to the
supporting of multiple actions within the same event, some of them are
really required arguments for a particular action. For example,
the event argument
|
16013 | |||
|
*msgIDs | Specifies an argument for message ids |
16205 | ||
|
*msgIDsWithStates | Specifies an argument for message ids with their state. |
16206 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES |
|
|
*msgIDsWithStatuses | Specifies an argument for message ids with their status. |
16207 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS |
|
|
*singleStatus | Specifies an argument for a single message status. |
16208 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS |
|
|
*sortField | Specifies an argument for the sorting field. |
16209 | ||
|
details | Specifies an argument for the Highlighting. True if during highlighting, one wants to specify that details should be added. |
16212 | ||
|
dupMsgs | Specifies a user action of duplicating inbox messages. |
16218 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_DUPLICATE_MESSAGES |
|
|
highlightAllMsgs | Specifies a user action of highlighting all messages. |
16222 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_ALL_MESSAGES |
|
|
highlightMsgs | Specifies a user action of selecting/unselecting all messages. |
16223 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_MESSAGES |
|
|
inboxFlags | Specifies an argument for Inbox flags. |
16203 | ||
|
removeAllMsgs | Specifies a user action of removing all messages from inbox. |
16220 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_REMOVE_ALL_MESSAGES |
|
|
removeMsgs | Specifies a user action of removing inbox messages. |
16215 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES |
|
|
retrieveMsgs | Specifies a user action of retrieving Inbox messages. |
16214 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_RETRIEVE_MESSAGES |
|
|
saveMsgs | Specifies a user action of saving messages to inbox. |
16219 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SAVE_MESSAGES |
|
|
setSelected | Specifies an argument for the Selected. True if one wants to set the message as selected else false. |
16213 | ||
|
setSingleStatus | Specifies a user action setting inbox messages to the same status. |
16217 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SET_SINGLE_STATUS |
|
|
setVarStatus | Specifies a user action of setting inbox message status. |
16216 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SET_VARIOUS_STATUS |
|
|
slctAllMsgs | Specifies a user action of highlighting the messages with message IDs passed. |
16224 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SELECT_ALL_MESSAGES |
|
|
slctMsgs | Specifies a user action of selecting/unselecting messages with messageIDs passed. |
16225 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SELECT_MESSAGES |
|
|
sortAscending | Specifies an argument for the sorting order. True if sorting in ascending order. |
16210 | ||
|
sortMsgs | Specifies a user action of sorting inbox messages on the current screem. |
16221 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES |
|
| RemoveAllInboxMessages | ||||
| Specifies an event to remove all messages from Inbox. |
16007 | |||
|
inboxFlags | Specifies an argument for Inbox flags. |
16203 | ||
| RemoveInboxMessages | ||||
| Specifies an event to remove Inbox messages. |
16002 | |||
|
*msgIDs | Specifies an argument for message ids |
16205 | ||
|
inboxFlags | Specifies an argument for Inbox flags. |
16203 | ||
| RetrieveInboxMessages | ||||
| Specifies an event to retrieve Inbox messages. |
16001 | |||
|
inboxFlags | Specifies an argument for Inbox flags. |
16203 | ||
| SaveMessagesToInbox | ||||
| Specifies an event to save messages to Inbox. |
16006 | |||
|
*msgIDsWithStates | Specifies an argument for message ids with their state. |
16206 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES |
|
| SelectAllMessages | ||||
| Specifies an event to highlight the messages with messageIDs passed. |
16011 | |||
|
setSelected | Specifies an argument for the Selected. True if one wants to set the message as selected else false. |
16213 | ||
| SelectMessages | ||||
| Specifies an event to select/unselect the messages with messageIDs passed. |
16012 | |||
|
*messageIDs | Specifies an argument for message ids |
16205 | ||
|
setSelected | Specifies an argument for the Selected. True if one wants to set the message as selected else false. |
16213 | ||
| SetSingleStatus | ||||
| Specifies an event to set Inbox messages to the same status. |
16004 | |||
|
*singleStatus | Specifies an argument for a single message status. |
16208 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS |
|
|
msgIDs | Specifies an argument for message ids |
16205 | ||
| SetVariousStatus | ||||
| Specifies an event to set Inbox message status. |
16003 | |||
|
*msgIDsWithStatuses | Specifies an argument for message ids with their status. |
16207 |
EnumInboxBeanEvents.INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS |
|
| SortMessages | ||||
| Specifies an event to sort Inbox messages on the current screen. |
16008 | |||
|
*sortField | Specifies an argument for the sorting field. |
16209 | ||
|
sortAscending | Specifies an argument for the sorting order. True if sorting in ascending order. |
16210 | ||
Notes
* denotes required field.