DataRecordSetChangeMessage

Class

This message is used when needing to implement a workflow upon the creation, update or removal of a record set. This message carries the changed DataRecordSet information. 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 Constructor
new DataRecordSetChangeMessage(widgetIdstring, changeTypeRecordSetChangeType, datastring[] | DataRecordSet[]): DataRecordSetChangeMessage

When removing data record sets, please pass in dataRecordSetNames; when adding or updating data record sets, please pass in dataRecordSets

Parameters
ParameterType
widgetId
string
changeType
RecordSetChangeType
data
string[] | DataRecordSet[]
Returns 
DataRecordSetChangeMessage

Properties

PropertyTypeNotes

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.

changeType

Class Property
changeType: RecordSetChangeType

The record set change type.

dataRecordSetNames

optional
Class Property
dataRecordSetNames: string[]

The name of the record sets. When removing some data record sets, only names are required.

dataRecordSets

optional
Class Property
dataRecordSets: DataRecordSet[]

The data record sets that are created or updated.

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