DataSourcesChangeMessage

Class

The DataSourcesChangeMessage uses the widget's id widgetId, the MessageType DATA_SOURCES_CHANGE message, the data source's change type DataSourcesChangeType (CREATE or REMOVE), and, the data sources DataSource[]. This message is used when needing to implement a workflow upon the creation or removal of some data sources. Other widgets may need to subscribe to this message whenever a workflow involves reliance on data sources change.

Implements

Constructors

constructor

Class Constructor
new DataSourcesChangeMessage(widgetIdstring, changeTypeDataSourcesChangeType, dataSourcesDataSource[]): DataSourcesChangeMessage
Parameters
ParameterType
widgetId
string
changeType
DataSourcesChangeType
dataSources
DataSource[]
Returns 
DataSourcesChangeMessage

Properties

PropertyTypeNotes

The change type.

The changed data sources.

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: DataSourcesChangeType

The change type.

dataSources

Class Property
dataSources: DataSource[]

The changed data sources.

type

Class Property
type: MessageType = MessageType.DataSourcesChange

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.