DataRecordsSelectionChangeMessage

Class

The DataRecordsSelectionChangeMessage uses the widgetId and the MessageType and the provides the selected records when the MessageType is 'DATA_RECORD_SET_CHANGE'. This message is used when implementing a workflow on a change of selected records. Other widgets within an experience may subscribe to this message and implement an update workflow when the message is received.

Implements

Constructors

new DataRecordsSelectionChangeMessage(widgetIdstring, recordsDataRecord[]): DataRecordsSelectionChangeMessage
Parameters
ParameterType
widgetId
string
records
DataRecord[]
Returns 
DataRecordsSelectionChangeMessage

Properties

PropertyTypeNotes

The selected records. To cancel selection, use an empty array.

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.

records

records: DataRecord[]

The selected records. To cancel selection, use an empty array.

type

type: MessageType = MessageType.DataRecordsSelectionChange

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.