Package com.microstrategy.web.beans

Interface EnumInboxBeanEvents

  • public interface EnumInboxBeanEvents
    Constants for inbox bean events
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • INBOX_EVENT_RETRIEVE_MESSAGES

        static final int INBOX_EVENT_RETRIEVE_MESSAGES
        Specifies an event to retrieve Inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_REMOVE_MESSAGES

        static final int INBOX_EVENT_REMOVE_MESSAGES
        Specifies an event to remove Inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SET_VARIOUS_STATUS

        static final int INBOX_EVENT_SET_VARIOUS_STATUS
        Specifies an event to set Inbox message status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SET_SINGLE_STATUS

        static final int INBOX_EVENT_SET_SINGLE_STATUS
        Specifies an event to set Inbox messages to the same status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_DUPLICATE_MESSAGES

        static final int INBOX_EVENT_DUPLICATE_MESSAGES
        Specifies an event to duplicate Inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SAVE_MESSAGES

        static final int INBOX_EVENT_SAVE_MESSAGES
        Specifies an event to save messages to Inbox.
        See Also:
        Constant Field Values

      • INBOX_EVENT_REMOVE_ALL_MESSAGES

        static final int INBOX_EVENT_REMOVE_ALL_MESSAGES
        Specifies an event to remove all messages from Inbox.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SORT_MESSAGES

        static final int INBOX_EVENT_SORT_MESSAGES
        Specifies an event to sort Inbox messages on the current screen.
        See Also:
        Constant Field Values

      • INBOX_EVENT_HIGHLIGHT_ALL_MESSAGES

        static final int INBOX_EVENT_HIGHLIGHT_ALL_MESSAGES
        Specifies an event to highlight all messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_HIGHLIGHT_MESSAGES

        static final int INBOX_EVENT_HIGHLIGHT_MESSAGES
        Specifies an event to select/unselect all messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SELECT_ALL_MESSAGES

        static final int INBOX_EVENT_SELECT_ALL_MESSAGES
        Specifies an event to highlight the messages with messageIDs passed.
        See Also:
        Constant Field Values

      • INBOX_EVENT_SELECT_MESSAGES

        static final int INBOX_EVENT_SELECT_MESSAGES
        Specifies an event to select/unselect the messages with messageIDs passed.
        See Also:
        Constant Field Values

      • INBOX_EVENT_PROCESS_INBOX

        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.

        See Also:
        Constant Field Values

      • INBOX_EVENT_EDIT_RENAME_MESSAGE

        static final int INBOX_EVENT_EDIT_RENAME_MESSAGE
        Configures a message as editable.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_INBOX_FLAGS

        static final int INBOX_EVENT_ARGUMENT_INBOX_FLAGS
        Specifies an argument for Inbox flags.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_MESSAGE_IDS

        static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS
        Specifies an argument for message ids
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES

        static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATES
        Specifies an argument for message ids with their state.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS

        static final int INBOX_EVENT_ARGUMENT_MESSAGE_IDS_WITH_STATUS
        Specifies an argument for message ids with their status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS

        static final int INBOX_EVENT_ARGUMENT_SINGLE_MESSAGE_STATUS
        Specifies an argument for a single message status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_SORT_FIELD

        static final int INBOX_EVENT_ARGUMENT_SORT_FIELD
        Specifies an argument for the sorting field.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_SORT_ASCENDING

        static final int INBOX_EVENT_ARGUMENT_SORT_ASCENDING
        Specifies an argument for the sorting order. True if sorting in ascending order.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ADD_DETAILS

        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.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_SET_SELECTED

        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.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_RETRIEVE_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_RETRIEVE_MESSAGES
        Specifies a user action of retrieving Inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_MESSAGES
        Specifies a user action of removing inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SET_VARIOUS_STATUS

        static final int INBOX_EVENT_ARGUMENT_ACTION_SET_VARIOUS_STATUS
        Specifies a user action of setting inbox message status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SET_SINGLE_STATUS

        static final int INBOX_EVENT_ARGUMENT_ACTION_SET_SINGLE_STATUS
        Specifies a user action setting inbox messages to the same status.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_DUPLICATE_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_DUPLICATE_MESSAGES
        Specifies a user action of duplicating inbox messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SAVE_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_SAVE_MESSAGES
        Specifies a user action of saving messages to inbox.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_REMOVE_ALL_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_REMOVE_ALL_MESSAGES
        Specifies a user action of removing all messages from inbox.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_SORT_MESSAGES
        Specifies a user action of sorting inbox messages on the current screem.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_ALL_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_ALL_MESSAGES
        Specifies a user action of highlighting all messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_HIGHLIGHT_MESSAGES
        Specifies a user action of selecting/unselecting all messages.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SELECT_ALL_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_SELECT_ALL_MESSAGES
        Specifies a user action of highlighting the messages with message IDs passed.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_ACTION_SELECT_MESSAGES

        static final int INBOX_EVENT_ARGUMENT_ACTION_SELECT_MESSAGES
        Specifies a user action of selecting/unselecting messages with messageIDs passed.
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_MESSAGE_ID

        static final int INBOX_EVENT_ARGUMENT_MESSAGE_ID
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • INBOX_EVENT_ARGUMENT_MESSAGE_NAME

        static final int INBOX_EVENT_ARGUMENT_MESSAGE_NAME
        Specifies an argument for message name.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values