DataRecordsSelectionChangeMessage
Class
The DataRecordsSelectionChangeMessage uses the widgetId and the MessageType and the provides
the selected records when the MessageType is 'DATA_RECORD_SET_CHANGE'. This message is used when
implementing a workflow on a change of selected records. Other widgets
within an experience may subscribe to this message and implement an update workflow when the message
is received.
Implements
Constructors
constructor
Class Constructornew DataRecordsSelectionChangeMessage(widgetId: string, records: DataRecord[]): DataRecordsSelectionChangeMessageParameters
| Parameter | Type |
|---|---|
widget | string |
records | DataRecord[] |
Returns
DataRecordsSelectionChangeMessageProperties
| Property | Type | Notes |
|---|---|---|
The selected records. To cancel selection, use an empty array. | ||
The message type. | ||
string | The widget id from which the message is sourced. If a widget id is not provided, the message is provided by the Jimu framework. |
type
Class Propertytype: MessageType = MessageType.DataRecordsSelectionChangeThe message type.
records: DataRecord[]The selected records. To cancel selection, use an empty array.