MessageAction

Interface

The interface for all message actions. Message action executes when a matched message is received.

Properties

PropertyTypeNotes
() => void
(messageMessage) => boolean
(messageDescriptionMessageDescription) => boolean
(messageTypeMessageType, messageWidgetId?string) => string
string

The unique id of the action. For actions provided by a widget, the id is: widgetId + actionName.

string

The action label. To support i18n, use _action_${actionName} as the string key.

string

The action name.

(messageMessage, actionConfig?any) => boolean | Promise<boolean>
(messageTypeMessageType, messageWidgetId?string) => void
string

The widget id that provides the action. If a widget id is not provided, the action is provided by the Jimu framework.

destroy

Interface Property
destroy: () => void
Type declaration
    function(): void

    When a widget is removed, actions provided by this widget will be destroyed.

    Returns 
    void

filterMessage

Interface Property
filterMessage: (messageMessage) => boolean
Type declaration
    function(messageMessage): boolean

    This indicates whether a specific message can trigger the filter message action. This method is used to filter messages in the message manager.

    Parameters
    ParameterType
    message
    Message
    Returns 
    boolean

filterMessageDescription

Interface Property
filterMessageDescription: (messageDescriptionMessageDescription) => boolean
Type declaration
    function(messageDescriptionMessageDescription): boolean

    This indicates whether or not the type of message can trigger the filter message action. This method is used in builder to filter the available actions.

    Parameters
    ParameterType
    messageDescription
    MessageDescription
    Returns 
    boolean

getSettingComponentUri

optional
Interface Property
getSettingComponentUri: (messageTypeMessageType, messageWidgetId?string) => string
Type declaration
    function(messageTypeMessageType, messageWidgetId?string): string

    This returns the action setting component uri. The returned value should match thesettingUri from the widget manifest. If no setting is required, null is returned.

    This method is required for framework actions but optional for widget actions.

    This setting component is used to configure the action according to the message.

    Parameters
    ParameterType
    messageType
    MessageType
    messageWidgetId
    string
    Returns 
    string

id

Interface Property
id: string

The unique id of the action. For actions provided by a widget, the id is: widgetId + actionName.

label

Interface Property
label: string

The action label. To support i18n, use _action_${actionName} as the string key.

name

optional
Interface Property
name: string

The action name.

onExecute

Interface Property
onExecute: (messageMessage, actionConfig?any) => boolean | Promise<boolean>
Type declaration
    function(messageMessage, actionConfig?any): boolean | Promise<boolean>

    The execution of the action when the message is matched.

    Please make sure this method returns true to indicate the action is executed successfully, so the following actions can be executed.

    Parameters
    ParameterType
    message
    Message
    actionConfig
    any
    Returns 
    boolean | Promise<boolean>

onRemoveListen

Interface Property
onRemoveListen: (messageTypeMessageType, messageWidgetId?string) => void
Type declaration
    function(messageTypeMessageType, messageWidgetId?string): void

    When an action is removed from a message's listener, this function will be invoked.

    Parameters
    ParameterType
    messageType
    MessageType
    messageWidgetId
    string
    Returns 
    void

widgetId

optional
Interface Property
widgetId: string

The widget id that provides the action. If a widget id is not provided, the action is provided by the Jimu framework.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.