public interface

EnumInboxBeanEvents

com.microstrategy.web.beans.EnumInboxBeanEvents

Class Overview

Constants for inbox bean events

Summary

Constants
int INBOX_EVENT_ARGUMENT_ACTION_DUPLICATE_MESSAGES Specifies a user action of duplicating inbox messages.
int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_ALL_MESSAGES Specifies a user action of highlighting all messages.
int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_MESSAGES Specifies a user action of selecting/unselecting all messages.
int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_ALL_MESSAGES Specifies a user action of removing all messages from inbox.
int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES Specifies a user action of removing inbox messages.
int INBOX_EVENT_ARGUMENT_ACTION_RETRIEVE_MESSAGES Specifies a user action of retrieving Inbox messages.
int INBOX_EVENT_ARGUMENT_ACTION_SAVE_MESSAGES Specifies a user action of saving messages to inbox.
int INBOX_EVENT_ARGUMENT_ACTION_SELECT_ALL_MESSAGES Specifies a user action of highlighting the messages with message IDs passed.
int INBOX_EVENT_ARGUMENT_ACTION_SELECT_MESSAGES Specifies a user action of selecting/unselecting messages with messageIDs passed.
int INBOX_EVENT_ARGUMENT_ACTION_SET_SINGLE_STATUS Specifies a user action setting inbox messages to the same status.
int INBOX_EVENT_ARGUMENT_ACTION_SET_VARIOUS_STATUS Specifies a user action of setting inbox message status.
int INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES Specifies a user action of sorting inbox messages on the current screem.
int INBOX_EVENT_ARGUMENT_ADD_DETAILS Specifies an argument for the Highlighting.
int INBOX_EVENT_ARGUMENT_INBOX_FLAGS Specifies an argument for Inbox flags.
int INBOX_EVENT_ARGUMENT_MESSAGE_ID
int INBOX_EVENT_ARGUMENT_MESSAGE_IDS Specifies an argument for message ids
int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES Specifies an argument for message ids with their state.
int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS Specifies an argument for message ids with their status.
int INBOX_EVENT_ARGUMENT_MESSAGE_NAME Specifies an argument for message name.
int INBOX_EVENT_ARGUMENT_SET_SELECTED Specifies an argument for the Selected.
int INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS Specifies an argument for a single message status.
int INBOX_EVENT_ARGUMENT_SORT_ASCENDING Specifies an argument for the sorting order.
int INBOX_EVENT_ARGUMENT_SORT_FIELD Specifies an argument for the sorting field.
int INBOX_EVENT_CANCEL_RENAME_MESSAGE Cancels the INBOX_EVENT_EDIT_RENAME_MESSAGE state.
int INBOX_EVENT_DUPLICATE_MESSAGES Specifies an event to duplicate Inbox messages.
int INBOX_EVENT_EDIT_RENAME_MESSAGE Configures a message as editable.
int INBOX_EVENT_HIGHLIGHT_ALL_MESSAGES Specifies an event to highlight all messages.
int INBOX_EVENT_HIGHLIGHT_MESSAGES Specifies an event to select/unselect all messages.
int INBOX_EVENT_PROCESS_INBOX Specifies an event to process any supported user action.
int INBOX_EVENT_REMOVE_ALL_MESSAGES Specifies an event to remove all messages from Inbox.
int INBOX_EVENT_REMOVE_MESSAGES Specifies an event to remove Inbox messages.
int INBOX_EVENT_RENAME Renames a message previously configured as editable INBOX_EVENT_EDIT_RENAME_MESSAGE with a new name.
int INBOX_EVENT_RETRIEVE_MESSAGES Specifies an event to retrieve Inbox messages.
int INBOX_EVENT_SAVE_MESSAGES Specifies an event to save messages to Inbox.
int INBOX_EVENT_SELECT_ALL_MESSAGES Specifies an event to highlight the messages with messageIDs passed.
int INBOX_EVENT_SELECT_MESSAGES Specifies an event to select/unselect the messages with messageIDs passed.
int INBOX_EVENT_SET_SINGLE_STATUS Specifies an event to set Inbox messages to the same status.
int INBOX_EVENT_SET_VARIOUS_STATUS Specifies an event to set Inbox message status.
int INBOX_EVENT_SORT_MESSAGES Specifies an event to sort Inbox messages on the current screen.

Constants

public static final int INBOX_EVENT_ARGUMENT_ACTION_DUPLICATE_MESSAGES

Specifies a user action of duplicating inbox messages.

Constant Value: 16218 (0x00003f5a)

public static final int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_ALL_MESSAGES

Specifies a user action of highlighting all messages.

Constant Value: 16222 (0x00003f5e)

public static final int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_MESSAGES

Specifies a user action of selecting/unselecting all messages.

Constant Value: 16223 (0x00003f5f)

public static final int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_ALL_MESSAGES

Specifies a user action of removing all messages from inbox.

Constant Value: 16220 (0x00003f5c)

public static final int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES

Specifies a user action of removing inbox messages.

Constant Value: 16215 (0x00003f57)

public static final int INBOX_EVENT_ARGUMENT_ACTION_RETRIEVE_MESSAGES

Specifies a user action of retrieving Inbox messages.

Constant Value: 16214 (0x00003f56)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SAVE_MESSAGES

Specifies a user action of saving messages to inbox.

Constant Value: 16219 (0x00003f5b)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SELECT_ALL_MESSAGES

Specifies a user action of highlighting the messages with message IDs passed.

Constant Value: 16224 (0x00003f60)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SELECT_MESSAGES

Specifies a user action of selecting/unselecting messages with messageIDs passed.

Constant Value: 16225 (0x00003f61)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SET_SINGLE_STATUS

Specifies a user action setting inbox messages to the same status.

Constant Value: 16217 (0x00003f59)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SET_VARIOUS_STATUS

Specifies a user action of setting inbox message status.

Constant Value: 16216 (0x00003f58)

public static final int INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES

Specifies a user action of sorting inbox messages on the current screem.

Constant Value: 16221 (0x00003f5d)

public static final int INBOX_EVENT_ARGUMENT_ADD_DETAILS

Specifies an argument for the Highlighting. True if during highlighting, one wants to specify that details should be added.

Constant Value: 16212 (0x00003f54)

public static final int INBOX_EVENT_ARGUMENT_INBOX_FLAGS

Specifies an argument for Inbox flags.

Constant Value: 16203 (0x00003f4b)

public static final int INBOX_EVENT_ARGUMENT_MESSAGE_ID

Constant Value: 16226 (0x00003f62)

public static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS

Specifies an argument for message ids

Constant Value: 16205 (0x00003f4d)

public static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES

Specifies an argument for message ids with their state.

Constant Value: 16206 (0x00003f4e)

public static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS

Specifies an argument for message ids with their status.

Constant Value: 16207 (0x00003f4f)

public static final int INBOX_EVENT_ARGUMENT_MESSAGE_NAME

Specifies an argument for message name.

Constant Value: 16227 (0x00003f63)

public static final int INBOX_EVENT_ARGUMENT_SET_SELECTED

Specifies an argument for the Selected. True if one wants to set the message as selected else false.

Constant Value: 16213 (0x00003f55)

public static final int INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS

Specifies an argument for a single message status.

Constant Value: 16208 (0x00003f50)

public static final int INBOX_EVENT_ARGUMENT_SORT_ASCENDING

Specifies an argument for the sorting order. True if sorting in ascending order.

Constant Value: 16210 (0x00003f52)

public static final int INBOX_EVENT_ARGUMENT_SORT_FIELD

Specifies an argument for the sorting field.

Constant Value: 16209 (0x00003f51)

public static final int INBOX_EVENT_CANCEL_RENAME_MESSAGE

Constant Value: 16016 (0x00003e90)

public static final int INBOX_EVENT_DUPLICATE_MESSAGES

Specifies an event to duplicate Inbox messages.

Constant Value: 16005 (0x00003e85)

public static final int INBOX_EVENT_EDIT_RENAME_MESSAGE

Configures a message as editable.

Constant Value: 16014 (0x00003e8e)

public static final int INBOX_EVENT_HIGHLIGHT_ALL_MESSAGES

Specifies an event to highlight all messages.

Constant Value: 16009 (0x00003e89)

public static final int INBOX_EVENT_HIGHLIGHT_MESSAGES

Specifies an event to select/unselect all messages.

Constant Value: 16010 (0x00003e8a)

public static final int INBOX_EVENT_PROCESS_INBOX

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 INBOX_EVENT_ARGUMENT_ACTION_ to distinguish from other event arguments.

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 INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES, look for those arguments defined in the corresponding smaller event INBOX_EVENT_REMOVE_MESSAGES.

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 INBOX_EVENT_ARGUMENT_SORT_FIELD is a required argument for the user action INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES.

Constant Value: 16013 (0x00003e8d)

public static final int INBOX_EVENT_REMOVE_ALL_MESSAGES

Specifies an event to remove all messages from Inbox.

Constant Value: 16007 (0x00003e87)

public static final int INBOX_EVENT_REMOVE_MESSAGES

Specifies an event to remove Inbox messages.

Constant Value: 16002 (0x00003e82)

public static final int INBOX_EVENT_RENAME

Renames a message previously configured as editable INBOX_EVENT_EDIT_RENAME_MESSAGE with a new name.

Constant Value: 16015 (0x00003e8f)

public static final int INBOX_EVENT_RETRIEVE_MESSAGES

Specifies an event to retrieve Inbox messages.

Constant Value: 16001 (0x00003e81)

public static final int INBOX_EVENT_SAVE_MESSAGES

Specifies an event to save messages to Inbox.

Constant Value: 16006 (0x00003e86)

public static final int INBOX_EVENT_SELECT_ALL_MESSAGES

Specifies an event to highlight the messages with messageIDs passed.

Constant Value: 16011 (0x00003e8b)

public static final int INBOX_EVENT_SELECT_MESSAGES

Specifies an event to select/unselect the messages with messageIDs passed.

Constant Value: 16012 (0x00003e8c)

public static final int INBOX_EVENT_SET_SINGLE_STATUS

Specifies an event to set Inbox messages to the same status.

Constant Value: 16004 (0x00003e84)

public static final int INBOX_EVENT_SET_VARIOUS_STATUS

Specifies an event to set Inbox message status.

Constant Value: 16003 (0x00003e83)

public static final int INBOX_EVENT_SORT_MESSAGES

Specifies an event to sort Inbox messages on the current screen.

Constant Value: 16008 (0x00003e88)