Interface
The interface for all message actions. Message action executes when a matched message is received.
Properties
| Property | Type | Notes |
|---|---|---|
destroy | () => void | When a widget is removed, actions provided by this widget will be destroyed. |
filterMessage | (message: Message) => boolean | This indicates whether a specific message can trigger the filter message action. This method is used to filter messages in the message manager. |
filterMessageDescription | (messageDescription: MessageDescription) => 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. |
getDefaultMessageActionConfig | (message: Message) => any | Get the default message action config. This method is called when a new message action is configured in the builder. |
getSettingComponentUri | (messageType: MessageType, messageWidgetId?: string) => string | This returns the action setting component uri. The returned value should match the
|
id | string | The unique id of the action. For actions provided by a widget, the id is: widgetId + actionName. |
label | string | The action label. To support i18n, use |
name | string | The action name. |
onExecute | (message: Message, actionConfig?: any) => boolean | Promise<boolean> | The execution of the action when the message is matched. |
onRemoveListen | (messageType: MessageType, messageWidgetId?: string) => void | When an action is removed from a message's listener, this function will be invoked. |
sectionId | string | The section ID that provides the action. If a widget id or section id is not provided, the action is provided by the Jimu framework. |
widgetId | string | The widget ID that provides the action. If a widget id or section id is not provided, the action is provided by the Jimu framework. |