DataRecordSetChangeMessage
Class
The DataRecordSetChangeMessage uses the widget's id widgetId, the MessageType DATA_RECORD_SET_CHANGE message,
the id of the record set dataRecordSetId, the record set's change type RecordSetChangeType (CREATE,UPDATE or REMOVE), and, optionally, the record set DataRecordSet. This message is used when
needing to implement a workflow upon the creation, update or removal of a record set. Other widgets may
need to subscribe to this message whenever a workflow involves reliance on a change to record set(s).
Implements
Constructors
constructor
Class Constructornew DataRecordSetChangeMessage(widgetId: string, changeType: RecordSetChangeType, data: string[] | DataRecordSet[]): DataRecordSetChangeMessageWhen removing data record sets, please pass in dataRecordSetNames; when adding or updating data record sets, please pass in dataRecordSets
Parameters
| Parameter | Type |
|---|---|
widget | string |
change | RecordSetChangeType |
data | string[] | DataRecordSet[] |
Returns
DataRecordSetChangeMessageProperties
| Property | Type | Notes |
|---|---|---|
The record set change type. | ||
string[] | The name of the record sets. When removing some data record sets, only names are required. | |
The data record sets that are created or updated. | ||
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. |
dataRecordSetNames
dataRecordSetNames: string[]The name of the record sets. When removing some data record sets, only names are required.
dataRecordSets
dataRecordSets: DataRecordSet[]The data record sets that are created or updated.
type
Class Propertytype: MessageType = MessageType.DataRecordSetChangeThe message type.
changeType: RecordSetChangeTypeThe record set change type.