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