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.

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

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.

type

Class Property
type: MessageType = MessageType.DataRecordSetChange

The message type.

widgetId

Class Property
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.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close