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. |
destroy
Interface Propertydestroy: () => voidWhen a widget is removed, actions provided by this widget will be destroyed.
Type declaration
function(): voidReturns
voidfilterMessageDescription
Interface PropertyfilterMessageDescription: (messageDescription: MessageDescription) => booleanThis 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.
Type declaration
function(messageDescription: MessageDescription): booleanParameters
| Parameter | Type |
|---|---|
message | MessageDescription |
Returns
booleangetSettingComponentUri
getSettingComponentUri: (messageType: MessageType, messageWidgetId?: string) => stringThis returns the action setting component uri. The returned value should match the
settingUri 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.
Type declaration
function(messageType: MessageType, messageWidgetId?: string): stringParameters
| Parameter | Type |
|---|---|
message | MessageType |
message | string |
Returns
stringid
Interface Propertyid: stringThe unique id of the action. For actions provided by a widget, the id is: widgetId + actionName.
label
Interface Propertylabel: stringThe action label. To support i18n, use _action_${actionName} as the string key.
onExecute
Interface PropertyonExecute: (message: Message, 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.
Type declaration
onRemoveListen
Interface PropertyonRemoveListen: (messageType: MessageType, messageWidgetId?: string) => voidWhen an action is removed from a message's listener, this function will be invoked.
Type declaration
function(messageType: MessageType, messageWidgetId?: string): voidParameters
| Parameter | Type |
|---|---|
message | MessageType |
message | string |
Returns
void