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

new DataRecordSetChangeMessage(widgetIdstring, featureSetIdstring, changeTypeRecordSetChangeType, featureSet?DataRecordSet): DataRecordSetChangeMessage
Parameters
ParameterType
widgetId
string
featureSetId
string
changeType
RecordSetChangeType
featureSet
DataRecordSet
Returns 
DataRecordSetChangeMessage

Properties

PropertyTypeNotes

The record set change type.

dataRecordSet
 optional 

The optional record set.

string

The id of the record set.

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.

changeType

changeType: RecordSetChangeType

The record set change type.

dataRecordSet optional

dataRecordSet: DataRecordSet

The optional record set.

dataRecordSetId

dataRecordSetId: string

The id of the record set.

type

type: MessageType = MessageType.DataRecordSetChange

The message type.

widgetId

widgetId: 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.